API Reference
Business Impact Summary
The period as short plain English facts, ready for an email or a dashboard tile.
GET
/api/v1/reports/business-impact/summaryOrganic search and AI engine results for the window as a headline and short sections of facts, generated by rule from the same report. JSON only: format=csv is ignored here.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
domain | string | Optional | The domain to report on (e.g., "example.com"). Required when the key can read more than one domain; GET /api/v1/domains lists them. |
days | number | Optional | Window length in days, up to 366. The window ends on the last day data was received.Default: 28 |
from | string | Optional | Start of a calendar window, YYYY-MM-DD (use with to instead of days) |
to | string | Optional | End of a calendar window, YYYY-MM-DD |
Code Examples
curl:
JavaScript:
Try it
Response
200Summary (abridged)
409Google Analytics not connected
403Domain below the Business plan
Sent with a Retry-After header: the seconds until the next request is allowed.
429Rate limit exceeded