v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Logs v2.1

Get Log Entries

Gets log entries in a Project. By default, 25 log entries are returned. To change this value, use the limit query parameter. Additionally, you can filter, sort, and paginate the results. If you provide an invalid cursor value, a 400 error will be returned. When startDate or endDate are not provided, a default 1-hour time window is applied.

get/v2.1/projects/{projectId}/logs

Path parameters

projectIdstring required

The unique identifier for the Project.

Query parameters

filterstring

The type, msg or traceId of the log entry to filter the records

limitinteger

The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100.

skipinteger

The number of items to skip before returning the results. Use this parameter with limit for offset-based pagination. The default value is 0.

sortstring

The order in which results are returned. Set a sorting rule in the format field:direction, where direction can be asc for ascending order or desc for descending order. For example, name:asc sorts by name in ascending order.

nextstring

The cursor that points to the next page of results. Use the nextCursor value returned in a previous response to request the next set of items.

previousstring

The cursor that points to the previous page of results. Use the previousCursor value returned in a previous response to request the previous set of items.

typestring[]
userIdstring
flowNamestring
startDatestring date-time required
Example:2025-08-11T10:00:00.000Z

The start date for filtering log entries (ISO 8601 format). If not provided, defaults to 1 hour before endDate.

endDatestring date-time required
Example:2025-08-11T10:00:00.000Z

The end date for filtering log entries (ISO 8601 format). If not provided, defaults to the current time.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns array of Log Entries

totalinteger
nextCursorstring nullable
previousCursorstring nullable

Example response

{
  "total": 1
}