This endpoint makes a request in our database for the criteria passed in the parameters, and then returns a GUID that can be used to pull the finished report. You can specify the criteria for the report using an object titled "criteria". Report IDs will persist for 30 days.
What You Can Group & Filter By
Property | Group By ( | Filter By ( |
---|---|---|
| Yes | No |
| Yes | Yes |
When grouping/filtering by region, you must also group/filter by countryCode.
Important Troubleshooting Notes
-
Reports that are grouped by
Keyword
ANDCountry
orMetro
AND include a longer than 31 day time span are too large to be queued. -
StartDate
andEndDate
are additional deprecated body params that useMM/DD/YYYY
format. However, if you do not have your dates in ISO 8601 format, it's possible to use these params instead.StartDateISO
overridesStartDate
if different. -
If you choose the
GroupBy
optionId, your report will also be grouped byRateTypeId
. This is to break out data on separate lines if your flight changedRateType
during the time period. -
FlightId
will be returned asOptionId
in the report. -
Reports that GroupBy
hour
cannot use a time frame longer than 35 days from the present. -
You cannot queue a report that groups by or filters by both Keywords and Region or City.
-
Grouping by any "Device" dimensions does not work for requests. In other words, it is limited to performance reports and is currently not supported for inventory reports.
Report Creation Errors
All errors are wrapped in an {"Error"}
object.
Error Code | JSON Response | Error Description |
---|---|---|
500 |
| Report queuing is unavailable. Check the status page for details. If none are available, contact Kevel support |
403 |
| No API key in request, or the key does not belong to an account |
400 |
| No |
400 |
| Invalid JSON passed in the request. Includes a string with the parsing error |
400 |
| The Start Date is after the End Date |
400 |
| Both |
400 |
| Both |
400 |
|
|
400 |
|
|
400 |
| A parameter (such as |
400 |
| One of the |
400 |
| Invalid |
400 |
|
|
400 |
|
|
400 |
| Parameter property does not exist |
400 |
| Parameter value must be an integer |
400 |
| Parameter value must be a string (in the case of |
400 |
| Reports that are grouped by Keyword and Country/Metro AND include a longer than 31 day time span cannot be queued. |
400 |
| Reports that use the hourly date group can only be requested for a period within the past 35 days. |
400 |
| Reports cannot use both keywords and non-GMT (UTC) timezones. |