Analytics
note
This page documents the legacy v1 and v2 API, which remains available for existing integrations such as the Zapier app. New integrations should use the CheckFlow API v3 — see Migrating from v1 and v2.
Endpoint for retrieving analytical data on checklist and task activity over a specified period.
note
This endpoint requires API version 2.0.
Get Analytics
Returns an overview of all checklist and task activity within a specified date range.
GET /api/analytics/all
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
X-API-VERSION | Yes | Must be 2.0 |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
periodStartDate | string | Yes | — | The start of the reporting period. Format: YYYY-MM-DD. |
periodEndDate | string | No | Current date | The end of the reporting period. Format: YYYY-MM-DD. If omitted, defaults to today. |
Example Requests
GET https://app.checkflow.io/api/analytics/all?periodStartDate=2024-01-01&periodEndDate=2024-01-31
X-API-KEY: your-api-key-here
X-API-VERSION: 2.0
GET https://app.checkflow.io/api/analytics/all?periodStartDate=2024-01-01
X-API-KEY: your-api-key-here
X-API-VERSION: 2.0
Response Codes
| Code | Description |
|---|---|
200 | Returns the analytical data for the specified period. |
400 | periodStartDate is missing or periodStartDate is later than periodEndDate. |
401 | API key is missing or invalid. |
Related Pages
- Analytics — the same figures in the interface.
- Metrics Glossary — what each figure counts.