Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Logs API → Post Query

AI-generated

Summary

Send a query request to the Yext Logs API to retrieve log records based on specified filtering, field selection, sorting, pagination, and page size parameters.

Inputs

  • Fields — JSON array specifying the fields to return in each log record. If omitted or set to null, all fields are returned. Use ["*"] to explicitly request all fields.
  • Page Size — Number specifying the maximum number of log records to return in the response. Defaults to 50 if not set. Maximum supported value is 1000.
  • Descending — Boolean indicating whether records are returned in descending (true) or ascending (false) order based on timestamp. Defaults to ascending if not specified.
  • Filter — String expression to filter the log records returned. Supports various operators like &&, ||, ==, !=, <, >, <=, >=, has, !has, in, !in, and string containment (.containsAnyCase). If omitted, no filtering is applied.
  • Page Token — String token for paginating results. Use this value when continuing to retrieve records beyond the specified page size, as indicated by a nextPageToken in the response.

Output shape

a JSON object containing log records matching the query parameters

Response may include pagination metadata such as nextPageToken if more records exist beyond the current response. Use Page Token input to fetch additional pages accordingly.

Discussion