chatformdocs
API referenceV1

Headline numbers across every form: the last 7 days against the 7 before

GET
/v1/analytics/overview

Authorization

AuthorizationBearer <token>

A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.

In: header

Query Parameters

tz?integer

Minutes east of UTC that a day starts in, e.g. 330 for India. View counts are always UTC days.

Default0

Response Body

application/json

curl -X GET "https://example.com/v1/analytics/overview"
{  "days": 0,  "today": 0,  "kpis": {    "responses": {      "value": 0,      "previous": 0    },    "views": {      "value": 0,      "previous": 0    },    "completionRate": {      "value": 0,      "previous": 0    },    "partial": {      "value": 0,      "previous": 0    },    "medianMs": {      "value": 0,      "previous": 0    }  },  "series": {    "responses": [      0    ],    "views": [      0    ],    "completionRate": [      0    ],    "partial": [      0    ]  },  "locked": [    "string"  ]}