Analytics Overview
Retrieve account KPIs, daily series, rankings, comparisons, freshness, and coverage.
Retrieve account KPIs, daily series, rankings, comparisons, freshness, and coverage.
/api/v1/analytics/overviewReturn normalized analytics for the selected accounts and period.
| Parameter | Type | Default | Description |
|---|---|---|---|
days | number | 30 | Rolling range in days |
startDate, endDate | ISO date | — | Explicit range; both are required together |
platform | string | — | Restrict to one platform |
accountId, accountIds, groupId | string | — | Use exactly one account selector; accountIds is comma-separated |
comparison | previous | none | previous | Include the equal previous period only when coverage is complete |
metrics | string | — | Comma-separated public metric keys |
includeSeries | boolean | true | Include metric points |
curl --request GET \
--url 'https://dopost.co/api/v1/analytics/overview?days=30&comparison=previous' \
--header 'x-api-key: <apiKey>'curl --request GET \
--url 'https://dopost.co/api/v1/analytics/overview?days=30&comparison=previous' \
--header 'x-api-key: <apiKey>'{
"overview": {
"metrics": [
{ "key": "views", "value": 12400, "unit": "count", "aggregation": "DAY" }
],
"accounts": [
{
"rank": 1,
"accountId": "acc_123",
"platform": "INSTAGRAM",
"score": 82.4,
"metrics": []
}
],
"platforms": [
{
"rank": 1,
"platform": "INSTAGRAM",
"accountCount": 2,
"score": 82.4,
"metrics": []
}
]
},
"meta": {
"requestedRange": {
"startDate": "2026-07-24T00:00:00.000Z",
"endDate": "2026-08-22T23:59:59.999Z"
},
"dataThrough": "2026-08-22",
"lastUpdatedAt": "2026-08-23T03:10:00.000Z",
"comparisonCoverage": "complete"
}
}{
"overview": {
"metrics": [
{ "key": "views", "value": 12400, "unit": "count", "aggregation": "DAY" }
],
"accounts": [
{
"rank": 1,
"accountId": "acc_123",
"platform": "INSTAGRAM",
"score": 82.4,
"metrics": []
}
],
"platforms": [
{
"rank": 1,
"platform": "INSTAGRAM",
"accountCount": 2,
"score": 82.4,
"metrics": []
}
]
},
"meta": {
"requestedRange": {
"startDate": "2026-07-24T00:00:00.000Z",
"endDate": "2026-08-22T23:59:59.999Z"
},
"dataThrough": "2026-08-22",
"lastUpdatedAt": "2026-08-23T03:10:00.000Z",
"comparisonCoverage": "complete"
}
}Metrics include a stable key, label, value, unit, aggregation, availability and observation period. Unavailable values are omitted or returned as null; measured zero values are returned as 0. Daily account data ends on the latest complete day.
| Status | Cause |
|---|---|
400 | Invalid filters, dates, metrics, or a range outside plan history |
401 | Invalid or missing API key |
403 | Missing analytics:read or Analytics is unavailable on the plan |
429 | Rate limit exceeded |
Use platform=GOOGLE_BUSINESS. impressions sums the four Search/Maps breakdowns; canonical views represents those same impressions in general comparisons. Do not add both values together. Specific keys are googleSearchDesktopImpressions, googleSearchMobileImpressions, googleMapsDesktopImpressions, googleMapsMobileImpressions, websiteClicks, callClicks, directionRequests, messagingClicks, bookings, and menuClicks.
Platform or single-account filters include available detail; multiple accounts or a group containing only Google Business also include detail by default. Mixed selections retain the canonical metrics; request specific keys with metrics. These are location metrics, not metrics attributable to individual posts. See monthly search terms.