Skip to main content

Request Insights Report

API Description

Request asynchronous creation of a report. Use the id provided in the response to later retrieve the report.

Request

URI Parameters

NameInput
orgId
REQUIRED
Path Template
POST {url}/api/{version}/orgs/{orgId}/reports
Path Example
POST {url}/api/v1/orgs/9467895078742654934/reports

Request Headers

NameInput
Authorization
REQUIRED
Content-Type
REQUIRED
Example Request Headers
Authorization: Bearer <access_token>
Content-Type: application/json

Request Body

NameInput
request
REQUIRED

Request

request defines the report parameters. Refer to Quick Report's request body for property descriptions.

Response

202 Accepted or Error

Response Headers

Name
apple-request-id
content-type
Example Response Headers
HTTP/1.1 202 Accepted
apple-request-id: 3e1318e4-a34f-49a7-8640-33d70bb4f49m
content-type: application/json

Response Body

NameOutput
$.orgId
REQUIRED
$.id
REQUIRED
$.createdDate
REQUIRED
$.expiryDate
REQUIRED
$.state
REQUIRED
$.request
REQUIRED
Example Response Body (raw JSON)
{
"orgId": "1503353735269908480",
"id": "9467895078742654967",
"createdDate": "2026-10-01T12:36:46.009Z",
"expiryDate": "2026-11-01T12:36:46.009Z",
"state": "PROCESSING",
"request": {
"resourceType": "LOCATION",
"resourceId": "180416478659477558",
"reportName": "SEARCH_LOCATION_TAP",
"startDate": "2026-10-01",
"endDate": "2026-10-07",
"timezone": "UTC",
"useLocalTime": false,
"timeGranularity": "DAY"
}
}