reporting

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-reporting"><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/d65e3578-b7f9-4b25-8f5a-68c1de7d7bf7/social-card.svg?v=3e7ae33eec8b" alt="reporting" width="600" height="315"></a>
POSThttps://hermetica.15.204.158.166.sslip.io/v1/reporting/values

Values report for campaigns, workflows, forms or segments: statistics list, timeframe, conversion metric, compare-to-previous

Request body

application/json
sourcestringrequired
campaign | workflow | form | segment
idsstring[]
statisticsstring[]required
timeframeobject
conversionMetricstring
groupBystring
source | channel | variant | message | template | provider | tag | list | segment | version = source
intervalstring
hour | day | week | month = day
sendChannelsstring[]
messageIdsstring[]
campaignFilterobject
Show child parameters
tagsstring[]
= []
listIdsstring[]
= []
segmentIdsstring[]
= []
compareToPreviousboolean
= false
{
  "source": "campaign",
  "ids": [
    "string"
  ],
  "statistics": [
    "queued"
  ],
  "timeframe": {
    "preset": "last_7_days"
  },
  "conversionMetric": "string",
  "groupBy": "source",
  "interval": "day",
  "sendChannels": [
    "email"
  ],
  "messageIds": [
    "string"
  ],
  "campaignFilter": {
    "tags": [],
    "listIds": [],
    "segmentIds": []
  },
  "compareToPrevious": false
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/reporting/values" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"campaign","ids":["string"],"statistics":["queued"],"timeframe":{"preset":"last_7_days"},"conversionMetric":"string","groupBy":"source","interval":"day","sendChannels":["email"],"messageIds":["string"],"campaignFilter":{"tags":[],"listIds":[],"segmentIds":[]},"compareToPrevious":false}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "from": "string",
  "to": "string",
  "rows": [
    {
      "key": "string",
      "label": "string",
      "statistics": {}
    }
  ],
  "totals": {},
  "previous": {
    "from": "string",
    "to": "string",
    "totals": {}
  }
}
Schema
fromstringrequired
tostringrequired
rowsobject[]required
Show child parameters
keystringrequired
labelstringrequired
statisticsobjectrequired
totalsobjectrequired
previousobjectrequired
Show child parameters
fromstringrequired
tostringrequired
totalsobjectrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/reporting/values

POSThttps://hermetica.15.204.158.166.sslip.io/v1/reporting/series

Time series of the same statistics, bucketed by day, week or month

Request body

application/json
sourcestringrequired
campaign | workflow | form | segment
idsstring[]
statisticsstring[]required
timeframeobject
conversionMetricstring
groupBystring
source | channel | variant | message | template | provider | tag | list | segment | version = source
intervalstring
hour | day | week | month = day
sendChannelsstring[]
messageIdsstring[]
campaignFilterobject
Show child parameters
tagsstring[]
= []
listIdsstring[]
= []
segmentIdsstring[]
= []
compareToPreviousboolean
= false
{
  "source": "campaign",
  "ids": [
    "string"
  ],
  "statistics": [
    "queued"
  ],
  "timeframe": {
    "preset": "last_7_days"
  },
  "conversionMetric": "string",
  "groupBy": "source",
  "interval": "day",
  "sendChannels": [
    "email"
  ],
  "messageIds": [
    "string"
  ],
  "campaignFilter": {
    "tags": [],
    "listIds": [],
    "segmentIds": []
  },
  "compareToPrevious": false
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/reporting/series" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"campaign","ids":["string"],"statistics":["queued"],"timeframe":{"preset":"last_7_days"},"conversionMetric":"string","groupBy":"source","interval":"day","sendChannels":["email"],"messageIds":["string"],"campaignFilter":{"tags":[],"listIds":[],"segmentIds":[]},"compareToPrevious":false}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "from": "string",
  "to": "string",
  "interval": "string",
  "points": [
    {
      "bucket": "string",
      "statistics": {}
    }
  ],
  "totals": {},
  "previous": {
    "from": "string",
    "to": "string",
    "totals": {}
  }
}
Schema
fromstringrequired
tostringrequired
intervalstringrequired
pointsobject[]required
Show child parameters
bucketstringrequired
statisticsobjectrequired
totalsobjectrequired
previousobjectrequired
Show child parameters
fromstringrequired
tostringrequired
totalsobjectrequired
4XX Default Response

Same as 4XX · POST /v1/reporting/values

5XX Default Response

Same as 4XX · POST /v1/reporting/values

Updated