Queries measure response data based upon the specified critiera. It can also provide a count of results only rather than returning the full report data.
\nThe criteria and domain elements must always be specified. Everything else is optional.
Query criteria can be specified for any column in the result set matching the colum name. Behind the scenes, the database query is built based upon the format of the JSON key for the criteria:
\nNote: Due to aliasing behind the scenes, some column queries may currently fail during development. If that happens, please contact Nathan with the column name so it can get resolved.
\nPagination is handled via a combination of the page, offset, and limit keys.
limit specifies the number of rows to return. The default is 100.page refers to the page of results to return, based upon the limit. The default is 1. This field is one based, not zero based.offset specifies the number of rows to offset. The default is 0.Note: offset takes priority over page if both are specified. Behind the scenes, page is converted to offset due to the underlying storage system.
Sorting is handled by the order_by key. This key takes an array of objects. The column key of each object refers to the column name; the direction key specifies the direction in which to sort. The valid direction options are: asc for ascending and desc, or - for descending. The default is an ascending sort. Any unrecognized sort value is discarded.
Time zone offsets are handled by the timezone key. This key takes a valid time zone string (e.g. \"America/Chicago\") and uses it for converting all exported date/time fields to the specified time zone. Defaults to UTC if omitted.
When developing locally, you can send a print_queries key set to true to cause the system's queries to print to the console. Due to how Django handles queries on the backend, this does have a minor performance impact, but can be useful for debugging. This only works locally or in the dev environment; the parameter will be ignored in all other environments.
Queries measure response data based upon the specified critiera and queues the data for export. Uses the exact same criteria syntax as the query endpoint with the addition of an export key. This record is only separated for simplicity of documentation.
To perform an export, the export key must be specified and include the format key. All other keys are optional.
format - The file format for the export. Supported options are: csvrequestor - UUID of the user requesting the export. This will be considered the file's owner.filename - Optional. If specified, the output will be saved using this filename. Default is Owl-[MON][day]-[year]-[hour]:[min]:[sec].[format extension]columns - Optional. If specified, it should be an array of JSON objects in the following format:{\"header\": \"[Column header for the column]\", \"field\": \"[The query field name as it appears in the query results]\"}
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Allows downloading the file for a single export
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Returns the status of a single export request
\nuuid - The UUID identifier of the export requestDeletes the specified export
\nuuid - The UUID identifier of the export requestReturns all export requests in the system for the specified user.
\nuuid - The UUID of the user whose exports you want to retrieve