This endpoint makes a request in the Kevel database for the criteria passed in the parameters, and then returns a GUID that can be used to pull the finished report. Criteria can be specified 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 (|
When grouping/filtering by region, be sure to also group/filter by countryCode.
Important Troubleshooting Notes
Reports that are grouped by
MetroAND include a longer than 31 day time span are too large to be queued.
If the dates are in ISO 8601 format, it is possible to use these params instead.
GroupByoptionId is chosen, the report will also be grouped by
RateTypeId. This is to meant to break out data on separate lines if the flight has changed
RateTypeduring the time period.
FlightIdwill be returned as
OptionIdin the report.
Reports that GroupBy
hourcannot use a time frame longer than 35 days from the present.
Reports may not be queued that groups by or filters by both Keywords and Region or City.
Grouping by any "device" dimensions (
formFactor) does not work for requests. In other words, it is limited to performance reports and is currently not supported for inventory reports.
For device reporting to be accurate, the client's UA needs to be passed through to Kevel via the User-Agent header if the customer is proxying events through their server. Failure to do so might cause inconsistent attribution, resulting in e.g. clicks without impressions, as one is not attributed to the same device.
Report Creation Errors
All errors are wrapped in an
|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||Invalid JSON passed in the request. Includes a string with the parsing error.|
|400||The Start Date is after the End Date.|
|400||A parameter (such as |
|400||One of the |
|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.|