Sign up to become a Hitchhiker and build skills that will enhance your career, get access to exclusive Yext resources, and be your brand’s hero by driving consumer engagement.
If you’re already a Hitchhiker, log in to access this content.
Congratulations, you’ve completed your first module!
We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Retrieve data from table. Available tables can be found by querying the GET Tables endpoint of the Logs API.
Table to query
A date in YYYYMMDD format.
API Key associated with your App that has access to Logs endpoint.
Request Body schema: application/json
JSON object containing fields, pageSize, sorting and filters to be applied to request.
Array of strings
Fields to return in request e.g. "fields":["eventTimestamp","accountId"].
This field is optional and will return all fields if no fields are specified. All fields can also be explicitly specified as follows: "fields" : ["*"]
Maximum number of records to return in request e.g. "pageSize":100.
This field is optional and will be set to 50 records if no pageSize is specified. pageSize supports a max 1,000 records. If query returns greater than pageSize specified, additional records require pagination.
Order of records are returned based on timestamp e.g. "descending": true.
This field is optional and will return records in ascending order if not specified.
Filter to apply to request e.g. "filter": "eventTimestamp < '2022-03-10T12:23:23.800Z'"
Filter Operators supported by Logs API:
&&: Combines multiple filter operators together. Records returned must satisfy both filters.