curl --request GET \
--url https://www.genviral.io/api/partner/v1/analytics/refreshes/fd8f615f-971e-4f9f-85dc-f8e55fb0a413 \
--header 'Authorization: Bearer <token>'
{
"ok": true,
"code": 200,
"message": "Analytics refresh status retrieved",
"data": {
"id": "fd8f615f-971e-4f9f-85dc-f8e55fb0a413",
"target_id": "e7a7f417-56db-4320-9e9a-fd6fdabda09d",
"status": "completed",
"workspace_id": "4cb5d3fd-8c8f-4ed7-a17c-4ffb52c7e6ac",
"credits_used": 1,
"free_refresh_used": false,
"started_at": "2026-02-14T16:05:11.025Z",
"completed_at": "2026-02-14T16:05:45.120Z",
"error": null
}
}
Analytics
Get Analytics Refresh
Check refresh status for an analytics refresh request
GET
/
api
/
partner
/
v1
/
analytics
/
refreshes
/
{id}
curl --request GET \
--url https://www.genviral.io/api/partner/v1/analytics/refreshes/fd8f615f-971e-4f9f-85dc-f8e55fb0a413 \
--header 'Authorization: Bearer <token>'
{
"ok": true,
"code": 200,
"message": "Analytics refresh status retrieved",
"data": {
"id": "fd8f615f-971e-4f9f-85dc-f8e55fb0a413",
"target_id": "e7a7f417-56db-4320-9e9a-fd6fdabda09d",
"status": "completed",
"workspace_id": "4cb5d3fd-8c8f-4ed7-a17c-4ffb52c7e6ac",
"credits_used": 1,
"free_refresh_used": false,
"started_at": "2026-02-14T16:05:11.025Z",
"completed_at": "2026-02-14T16:05:45.120Z",
"error": null
}
}
Use this endpoint to poll refresh progress after triggering
POST /analytics/targets/{id}/refresh.
Path Parameters
string
required
Refresh ID returned by the refresh endpoint.
Response
Returns the scoped refresh status payload fromsocial_analytics_refreshes.
string
Refresh ID.
string
Analytics target ID.
string
Current refresh status (
pending, processing, completed, failed).string | null
Workspace scope for refresh billing/context.
number
Credits charged for this refresh (
0 when free).boolean
Whether the free refresh window was used.
string
Refresh start timestamp.
string | null
Completion timestamp if finished.
string | null
Error message when status is
failed.curl --request GET \
--url https://www.genviral.io/api/partner/v1/analytics/refreshes/fd8f615f-971e-4f9f-85dc-f8e55fb0a413 \
--header 'Authorization: Bearer <token>'
{
"ok": true,
"code": 200,
"message": "Analytics refresh status retrieved",
"data": {
"id": "fd8f615f-971e-4f9f-85dc-f8e55fb0a413",
"target_id": "e7a7f417-56db-4320-9e9a-fd6fdabda09d",
"status": "completed",
"workspace_id": "4cb5d3fd-8c8f-4ed7-a17c-4ffb52c7e6ac",
"credits_used": 1,
"free_refresh_used": false,
"started_at": "2026-02-14T16:05:11.025Z",
"completed_at": "2026-02-14T16:05:45.120Z",
"error": null
}
}
Error Responses
400 missing_refresh_id- missing path parameter404 refresh_not_found- refresh ID not visible in authenticated key scope401/403- authentication failed or key lacks required scope access500- unexpected database lookup error
error_code field.