Reports

Create a report to retrieve analytics for each of your products using synchronous or asynchronous requests depending on the size of your data.

For more information available in the Reports API, check our documentation below:

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
async	boolean Defaults to false. When true, the report’s ID will be returned immediately and the report results can be fetched later. When false, the report results will be returned immediately, but an error may occur if the data requested is too large.
callback	string Optional. When async=true and callback is specified, the provided URL will be called when the report is ready. The URL must be of the form: `POST https://[your domain]/[your path]` It must accept the following parameters: `id: (string) - The ID of the report request which completed. status: (string) - One of [DONE, FAILED] indicating the result of the request. statusCode: (int) - An HTTP status code indicating the result of the request. message: (string) - When status=FAILED, contains an error message. url: (string) - When status=DONE, contains the URL to download the report data as a text file.`

Request Body schema: application/json

JSON object containing any filters to be applied to the report

metrics required	Array of strings The kinds of data the report should include. Specify up to 10 values.
dimensions required	Array of strings Determines how the data will be grouped. Specify up to 10 values. NOTES: You can only use one time-based dimension (e.g., `DAYS`, `WEEKS`) per report. You can only use one location-based dimension (e.g., `FOLDER_IDS`, `LOCATION_NAMES`) per report.
	object

Responses

Request samples

Payload

Content type

application/json

{"metrics": ["string"
],
"dimensions": ["string"
],
"filters": {"ANSWERS_BACKEND": ["ALGOLIA"
],
"ANSWERS_BLANK_SEARCH_TERM": true,
"ANSWERS_CLICK_LABEL": "string",
"ANSWERS_CLICK_TYPE": "string",
"ANSWERS_CLICK_URL": "string",
"ANSWERS_CLUSTER": "string",
"ANSWERS_CONFIGURATION_VERSION": ["string"
],
"ANSWERS_CONFIGURATION_VERSION_LABEL": ["string"
],
"ANSWERS_DIRECT_ANSWER_CLICK": true,
"ANSWERS_DIRECT_ANSWER_FIELD": "string",
"ANSWERS_DIRECT_ANSWER_FIELD_TYPE": ["string"
],
"ANSWERS_DIRECT_ANSWER_FIELD_VALUE": "string",
"ANSWERS_DIRECT_ANSWER_TYPE": ["string"
],
"ANSWERS_EXPERIENCE": ["string"
],
"ANSWERS_FILTER_KEY": ["string"
],
"ANSWERS_FILTER_OPERATOR": ["BETWEEN"
],
"ANSWERS_FILTER_SOURCE": ["ALGO"
],
"ANSWERS_FILTER_TYPE": ["FACET"
],
"ANSWERS_FILTER_VALUE": ["string"
],
"ANSWERS_HAS_CASE_START": true,
"ANSWERS_HAS_CASE_SUBMIT": true,
"ANSWERS_HAS_KG_RESULTS": true,
"ANSWERS_HAS_SEARCH_TERM_CLUSTER": true,
"ANSWERS_HAS_VOICE_SEARCH": true,
"ANSWERS_QUERY_SOURCE": ["STANDARD"
],
"ANSWERS_RAW_SEARCH_TERM": "string",
"ANSWERS_REFERRER_DOMAIN": "string",
"ANSWERS_REFERRER_PAGE_URL": "string",
"ANSWERS_RESULT_ENTITY_POSITION": 0,
"ANSWERS_RESULT_TITLE": "string",
"ANSWERS_RESULT_VERTICAL_POSITION": 0,
"ANSWERS_SEARCH_ID": "string",
"ANSWERS_SEARCH_TERM": "string",
"ANSWERS_SEARCH_TERM_CLUSTER_PERFORMANCE": [0
],
"ANSWERS_SEARCH_TERM_INTENT": "string",
"ANSWERS_SEARCH_VERTICAL": ["string"
],
"ANSWERS_SESSION_ID": "string",
"ANSWERS_TRAFFIC_TYPE": ["EXTERNAL"
],
"ANSWERS_USER_BROWSER": ["string"
],
"ANSWERS_USER_CITY": "string",
"ANSWERS_USER_COUNTRY": "string",
"ANSWERS_USER_DEVICE_CLASS": "string",
"ANSWERS_USER_LAT_LONG": "string",
"ANSWERS_USER_LOCATION_ACCURACY": "string",
"ANSWERS_USER_POSTAL_CODE": ["string"
],
"ANSWERS_USER_REGION": ["string"
],
"ANSWERS_VERTICAL_RETURNED": ["string"
],
"CLICK_TYPE": ["ADD_TO_CART"
],
"CONFIGURATION_VERSION_LABEL": ["PRODUCTION"
],
"CONVERSION_TYPE": ["COST_SAVING_CUSTOMER_SUPPORT"
],
"MEDIUM": "string",
"PRODUCT": ["ANSWERS"
],
"TRAFFIC_SOURCE": ["EXTERNAL"
],
"VALUE_PROPOSITION": ["COST_SAVINGS"
],
"VERTICAL_CONFIG_ID": "string",
"age": ["AGE13_17"
],
"VISITOR_EMAIL": ["string"
],
"VISITOR_ID": ["string"
],
"VISITOR_ID_METHOD": ["string"
],
"VISITOR_NAME": ["string"
],
"competitor": ["string"
],
"countries": ["string"
],
"customerActionType": ["ACTION_DRIVING_DIRECTIONS"
],
"endDate": "2017-01-31",
"entityGroup": ["CATEGORIES"
],
"entityIds": ["string"
],
"entityType": ["ATM"
],
"eventSearchCondition": ["INITIAL_SCAN"
],
"facebookImpressionType": ["ORGANIC"
],
"facebookRsvpType": ["ATTENDING"
],
"facebookStoryType": ["CHECKIN"
],
"folderIds": [0
],
"foursquareCheckinAge": ["AGE13_17"
],
"foursquareCheckinGender": "FEMALE",
"foursquareCheckinTimeOfDay": ["MORNING"
],
"foursquareCheckinType": "NEW",
"frequentWords": ["string"
],
"gender": "FEMALE",
"googleActionType": ["ACTION_DRIVING_DIRECTIONS"
],
"googleQueryType": ["QUERIES_CHAIN"
],
"hours": [23
],
"instagramContentType": "PHOTO",
"keyword": ["string"
],
"listingsLiveType": "CLAIMED",
"locationIds": ["string"
],
"locationLabels": ["string"
],
"matchPosition": ["ONE"
],
"matchType": ["COMPETITOR"
],
"maxSearchFrequency": 0,
"minSearchFrequency": 0,
"pageTypes": ["DIRECTORY"
],
"partners": [0
],
"platformType": ["BOT"
],
"publisherSuggestionType": ["ACCEPTED"
],
"queryTemplate": ["KEYWORD"
],
"ratings": [1
],
"reviewLabels": [0
],
"searchEngine": ["BING_DESKTOP"
],
"searchResultType": ["KNOWLEDGE_CARD_RESULT"
],
"searchTerms": "string",
"sentimentCollection": [0
],
"startDate": "2017-01-01"
}
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"data": [{"property1": "string",
"property2": "string"
}
],
"id": "string"
}
}