Check data request status

Collections

get /v1/data-requests/{dataRequestId}

Returns a safe status repeatedly without consuming the one-time result or charging again. After completion, call getDataRequestResult once to receive the result.

Authentication

• ApiKey bearer token

  Send the current Benchmark API key only in the Authorization header.

Path parameters

• dataRequestId string · uuid required

  The data request ID returned when a refresh is accepted.

Responses

• 200

  The current data request status. This can be checked repeatedly without delivering the result.

• 400

  The request failed validation.

• 401

  The bearer credential is missing or invalid.

• 403

  The key cannot perform this operation.

• 404

  The organization-owned data request was not found.

• 429

  The Cloudflare rate limiter rejected the request.

• 500

  The request failed without exposing internal diagnostics.

• 503

  A required service is unavailable.

Request

cURL

curl --request GET --url "${BENCHMARK_API_BASE_URL}/v1/data-requests/20000000-0000-4000-8000-000000000002" --header "Authorization: Bearer ${BENCHMARK_API_KEY}"

Response

200

{
  "dataRequest": {
    "id": "20000000-0000-4000-8000-000000000002",
    "status": "running",
    "statusMessage": "Your data request is being prepared. This may take some time.",
    "resultAvailable": false,
    "resultDelivered": false
  }
}