Lookup

Get Bulk Scores Request Status

Get the status of a previously submitted bulk scores report request. When the report is complete, the response will include a download_url that can be used to download the report data.

get/scores/bulk/{request_id}

Request

Base URL
https://api.morningconsult.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/morningconsult/apis/morning-consult-api/docs/scores/bulk/:request_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

request_idstring uuid required

The request ID returned from the bulk scores request.

Response

Bulk Scores Request Status

request_idstring uuid

The unique identifier for the bulk scores request.

status'processing' | 'complete' | 'error'

The current status of the report request.

download_urlstring uri

URL to download the completed report. Only present when status is complete.

expires_atstring date-time

Expiration time of the download URL. Only present when status is complete.

Example response

{
  "request_id": "b1a2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "complete",
  "download_url": "https://example.com/report.parquet",
  "expires_at": "2025-01-01T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.