Skip to content

Progress of an asynchronous report

GET /api/marketing/insights/reports/{reportRunId}

async_status goes from Job Not Started to Job Completed (or Job Failed) and async_percent_completion from 0 to 100. error_code and error_message only come if Meta failed the report. A report older than 30 days no longer exists on Meta’s side and answers the corresponding error. Requires the marketing:read scope.

StatusDescriptionSchema
200—InsightsReportRunDto
Terminal window
curl -X GET https://api.neike.dev/api/marketing/insights/reports/{reportRunId} \
-H "x-neike-api-key: whk_live_…"
FieldTypeDescription
report_run_idstringrequiredReport id. It expires after 30 days.
async_statusstringrequiredJob Not Started, Job Started, Job Running, Job Completed, Job Failed…
async_percent_completionnumberrequired0 a 100.
error_codenumberrequired—
error_messagestringrequired—