Sign in

v1

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Packs

Retrieve the logs of a Ingestion.

Retrieve the logs of a Ingestion for debugging purpose.

get/packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/logs

Path parameters

packIdinteger required

ID of a Pack

tenantIdstring required

ID of the tenant.

rootIngestionIdstring uuid required

ID of the root ingestion.

Query parameters

limitinteger

Maximum number of results to return in this query.

pageTokenstring

An opaque token used to fetch the next page of results.

logTypesPackLogType[]

Only return logs of the given types.

ingestionExecutionIdstring uuid

ID of the ingestion execution.

beforeTimestampstring date-time

Only return logs before the given time (non-inclusive).

afterTimestampstring date-time

Only return logs after the given time (non-inclusive).

ingestionStatus'QUEUED' | 'STARTED' | 'CANCELLED' | 'UP_FOR_RETRY' | 'COMPLETED' | 'FAILED'

Status of the ingestion execution.

Only fetch logs with the given ingestion status. This only works in combination with the onlyExecutionCompletions parameter.

onlyExecutionCompletionsboolean

Only fetch logs that represent the completion of a child execution.

order'asc' | 'desc'

Specifies if the logs will be returned in time desc or asc. Default is desc.

qstring

A search query that follows Lucene syntax.

requestIdsstring[]

Only return logs matching provided request IDs.

Response

Pack logs.

nextPageTokenstring

If specified, an opaque token used to fetch the next page of results.

nextPageLinkstring url

If specified, a link that can be used to fetch the next page of results.

Example response

{
  "items": [
    {
      "context": {
        "createdAt": "2018-04-11T00:18:57.946Z"
      },
      "message": "The formula is called!"
    }
  ],
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/packs/1/logs?pageToken=xyz"
}