Get Report

Fetch a raw data export using its id returned by a Export Report request. For successful requests (HTTP 200) use the ReportingExportResult object to see the status of the generated report and the url where the report will be stored.

We recommend fetching a report 10 seconds after its creation and retrying every 10 seconds until a status is in Processing. A positively generated report will have Completed status.

See Report section for a sample code.

Get export status

get

Authorizations

access_token

AuthorizationstringRequired

Token should be in format "Bearer {access_token}"

Path parameters

idstringRequired

Export ID

Header parameters

Authorizationstring | nullableOptional

Authorization header

X-Impersonate-Userstring | nullableOptional

Impersonation header

Responses

200

export

application/json

400

Bad request. Check fields message and error code from response body for additional information.

application/json

401

Unauthorized request. Check fields message and error code from response body for additional information.

application/json

403

Requested resource forbidden.Check fields message and error code from response body for additional information.

application/json

429

Too many requests. Check response header Retry-After indicating how long to wait before making a new request.

application/json

451

Unavailable because account is not verified.

application/json

get

/api/v1/report/exports/{id}

HTTPcURLJavaScriptPython

GET /api/v1/report/exports/{id} HTTP/1.1
Host: api.intheloop.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "status": "PendingOrExpired",
  "url": "text"
}

Sample request

https://api.intheloop.io/api/v1/report/exports/6e1cf0db-52d7-4522-97c9-97aa40b14058

Sample response body

{
  "id": "6e1cf0db-52d7-4522-97c9-97aa40b14058",
  "status": "Completed",
  "url": "https://reports.intheloop.io/RF_6a1cf0db-52d7-4522-97d9-97aa40b14058?Expires=1698934975&Signature=t7Wry-7LU4QlGoCmHtUYUpT4dKGTBTZMTREiIOjNtjtdpzc8S2inp9ov~SxLXH27p~QrAykF3ZpBJn6t4omedYcC-K1AGpgK8p~TIBiRL4KAf3kYuRlRUZtgtzoH2XQUy2biAPg2x7gg3e5t4GvFhjxbINENxdPrVtrOEFoYiFuZWMieaLA~Q~4bR5JRJ8urAvrBObML7LUwKU4dLhxJkNIP1T0LeAlkUi-8CTEctnqn-CDDxRq4J14mxbTaXyheICkyYkJhvO0SiUbRTbwihBS7iERUyjRH2ePUem~iD4lS8Ea-QQ~v7GO7IABin5rZ4PdAc6ndQ8WNVHkg6vLg7g__&Key-Pair-Id=K3OIERPZ19GBMM"
}

ReportingExportResult {

description:	Export Result resource
id*	[...]
status*	string Export status Enum: [ Expired, Failed, Processing, Completed ]
url	string Url of export result - with authorization (signature) and expire date

}