planner

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-planner"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/b48be2cf-3c9d-4797-900d-9a843634d0a3/social-card.svg?v=3e7ae33eec8b" alt="planner" width="600" height="315"></a>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/planner/goals

Business goals the planner can build a starter plan for

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/planner/goals" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "key": "grow_list",
      "label": "string",
      "summary": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

keystringrequired

labelstringrequired

summarystringrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/planner/goals

GEThttps://hermetica.15.204.158.166.sslip.io/v1/planner/goals/{goal}

Suggested segments, journeys and campaign drafts for one goal (nothing is created)

Parameters

goalstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/planner/goals/{goal}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "goal": "grow_list",
  "label": "string",
  "summary": "string",
  "items": [
    {
      "key": "string",
      "kind": "segment",
      "title": "string",
      "why": "string",
      "missing": []
    }
  ]
}

Schema

goalstringrequired

labelstringrequired

summarystringrequired

itemsobject[]required

Show child parameters

keystringrequired

kindstringrequired

segment | flow | campaign

titlestringrequired

whystringrequired

missingstring[]required

= []

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

POSThttps://hermetica.15.204.158.166.sslip.io/v1/planner/create

Create the ticked items of a plan as drafts (segments, journey drafts, campaign drafts); a failing item is reported, the rest still go through

Request body

application/json

goalstringrequired

keysstring[]required

{
  "goal": "grow_list",
  "keys": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/planner/create" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"goal":"grow_list","keys":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "created": [
    {
      "key": "string",
      "kind": "segment",
      "id": "string",
      "name": "string"
    }
  ],
  "skipped": [
    {
      "key": "string",
      "reason": "string"
    }
  ]
}

Schema

createdobject[]required

Show child parameters

keystringrequired

kindstringrequired

segment | flow | campaign

idstringrequired

namestringrequired

skippedobject[]required

Show child parameters

keystringrequired

reasonstringrequired

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

GEThttps://hermetica.15.204.158.166.sslip.io/v1/business-goals

Business goals with progress; ?archived=true lists archived ones

Parameters

archivedstringquery

true | false

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/business-goals" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "notes": "string",
      "metric": "revenue",
      "targetValue": 0,
      "currency": "string",
      "startsOn": "string",
      "endsOn": "string",
      "archivedAt": "2024-01-01T00:00:00Z",
      "progress": 0,
      "percent": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

notesstringrequired

metricstringrequired

revenue | conversions

targetValueintegerrequired

currencystringrequired

startsOnstringrequired

endsOnstringrequired

archivedAtstringrequired

progressintegerrequired

percentnumberrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

POSThttps://hermetica.15.204.158.166.sslip.io/v1/business-goals

Request body

application/json

namestringrequired

notesstring

= null

metricstringrequired

revenue | conversions

targetValueintegerrequired

currencystring

= null

startsOnstringrequired

endsOnstringrequired

{
  "name": "string",
  "notes": null,
  "metric": "revenue",
  "targetValue": 0,
  "currency": null,
  "startsOn": "string",
  "endsOn": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/business-goals" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","notes":null,"metric":"revenue","targetValue":0,"currency":null,"startsOn":"string","endsOn":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "notes": "string",
  "metric": "revenue",
  "targetValue": 0,
  "currency": "string",
  "startsOn": "string",
  "endsOn": "string",
  "archivedAt": "2024-01-01T00:00:00Z",
  "progress": 0,
  "percent": 0
}

Schema

idstringrequired

namestringrequired

notesstringrequired

metricstringrequired

revenue | conversions

targetValueintegerrequired

currencystringrequired

startsOnstringrequired

endsOnstringrequired

archivedAtstringrequired

progressintegerrequired

percentnumberrequired

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

GEThttps://hermetica.15.204.158.166.sslip.io/v1/business-goals/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/business-goals/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/business-goals

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/business-goals/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

notesstring

targetValueinteger

startsOnstring

endsOnstring

{
  "name": "string",
  "notes": "string",
  "targetValue": 0,
  "startsOn": "string",
  "endsOn": "string"
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/business-goals/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","notes":"string","targetValue":0,"startsOn":"string","endsOn":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/business-goals

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

POSThttps://hermetica.15.204.158.166.sslip.io/v1/business-goals/batch/archive

Archive goals (hidden, restorable)

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/business-goals/batch/archive" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "count": 0
}

Schema

countintegerrequired

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

POSThttps://hermetica.15.204.158.166.sslip.io/v1/business-goals/batch/restore

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/business-goals/batch/restore" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/business-goals/batch/archive

4XX Default Response

Same as 4XX · GET /v1/planner/goals

5XX Default Response

Same as 4XX · GET /v1/planner/goals

Updated Nov 3, 2026

Was this page helpful?