Skip to main content
GET
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 from social_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.

Error Responses

  • 400 missing_refresh_id - missing path parameter
  • 404 refresh_not_found - refresh ID not visible in authenticated key scope
  • 401/403 - authentication failed or key lacks required scope access
  • 500 - unexpected database lookup error
All error responses from analytics endpoints include an error_code field.