# List logs

Gets customer event logs for an account

Endpoint: POST /v1/analytics/logs
Version: 3.0.0
Security: basicAuth, basicAuth

## Request fields (application/json):

  - `start` (string)
    The start date (default: 1 day before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14

  - `end` (string)
    The end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14

  - `events` (array)
    The set of events to include.

  - `metric_events` (array)
    Optional set of analytics metric events. Will be converted into corresponding events.

  - `filter` (object)
    Filters to apply to the query.

  - `filter.AND` (array, required)

  - `filter.AND.attribute` (string, required)

  - `filter.AND.comparator` (string, required)

  - `filter.AND.values` (array, required)

  - `filter.AND.values.label` (string, required)

  - `filter.AND.values.value` (string, required)

  - `include_subaccounts` (boolean)
    Include logs from all subaccounts.

  - `include_totals` (boolean)
    Include total number of log entries.

  - `pagination` (object)

  - `pagination.sort` (string)
    Colon-separated value indicating column name and sort direction e.g. 'timestamp:desc'.

  - `pagination.token` (string)
    A token to the requested page.

  - `pagination.limit` (integer)
    The maximum number of items returned (100 max).

## Response 200 fields (application/json):

  - `start` (string, required)

  - `end` (string, required)

  - `items` (array, required)

  - `items.id` (string, required)

  - `items.event` (string, required)

  - `items.@timestamp` (string, required)

  - `items.account` (object)

  - `items.account.parent-id` (string)

  - `items.campaigns` (array)

  - `items.campaigns.name` (string)

  - `items.tags` (array)

  - `items.method` (string)

  - `items.originating-ip` (string)

  - `items.api-key-id` (string)

  - `items.delivery-status` (object)

  - `items.delivery-status.message` (string)

  - `items.delivery-status.attempt-no` (integer)

  - `items.delivery-status.code` (integer)

  - `items.delivery-status.bounce-type` (string)

  - `items.delivery-status.description` (string)

  - `items.delivery-status.session-seconds` (number)

  - `items.delivery-status.retry-seconds` (integer)

  - `items.delivery-status.enhanced-code` (string)

  - `items.delivery-status.mx-host` (string)

  - `items.delivery-status.certificate-verified` (boolean)

  - `items.delivery-status.tls` (boolean)

  - `items.delivery-status.utf8` (boolean)

  - `items.delivery-status.first-delivery-attempt-seconds` (number)

  - `items.delivery-status.last-code` (integer)

  - `items.delivery-status.last-message` (string)

  - `items.i-delivery-optimizer` (string)

  - `items.domain` (object, required)

  - `items.recipient` (string)

  - `items.recipient-domain` (string)

  - `items.recipient-provider` (string)

  - `items.envelope` (object)

  - `items.envelope.sender` (string)

  - `items.envelope.transport` (string)

  - `items.envelope.sending-ip` (string)

  - `items.envelope.targets` (string)

  - `items.envelope.i-ip-pool-id` (string)

  - `items.storage` (object)

  - `items.storage.region` (string)

  - `items.storage.env` (string)

  - `items.storage.key` (string)

  - `items.storage.url` (array)

  - `items.template` (object)

  - `items.template.version` (string)

  - `items.template.is-text` (boolean)

  - `items.log-level` (string)

  - `items.user-variables` (string)

  - `items.flags` (object)

  - `items.flags.is-authenticated` (boolean, required)

  - `items.flags.is-system-test` (boolean, required)

  - `items.flags.is-routed` (boolean, required)

  - `items.flags.is-amp` (boolean)

  - `items.flags.is-test-mode` (boolean, required)

  - `items.flags.is-delayed-bounce` (boolean, required)

  - `items.flags.is-callback` (boolean, required)

  - `items.flags.is-encrypted` (boolean)

  - `items.primary-dkim` (string)

  - `items.ip` (string)

  - `items.geolocation` (object)

  - `items.geolocation.city` (string)

  - `items.geolocation.country` (string)

  - `items.geolocation.timezone` (string)

  - `items.client-info` (object)

  - `items.client-info.client-name` (string)

  - `items.client-info.client-os` (string)

  - `items.client-info.client-type` (string)

  - `items.client-info.device-type` (string)

  - `items.client-info.user-agent` (string)

  - `items.client-info.bot` (string)

  - `items.severity` (string)

  - `items.reason` (string)

  - `items.routes` (object)

  - `items.routes.actions` (string)

  - `items.routes.expression` (string)

  - `items.routes.priority` (integer)

  - `items.routes.match` (object)

  - `items.mailing-list` (object)

  - `items.mailing-list.address` (string)

  - `items.mailing-list.list-id` (string)

  - `items.mailing-list.sid` (string)

  - `pagination` (object, required)

  - `pagination.previous` (string)
    Token to previous page

  - `pagination.next` (string)
    Token to next page

  - `pagination.first` (string)
    Token to first page

  - `pagination.last` (string)
    Token to last page

  - `pagination.total` (integer)
    Total number of items

  - `aggregates` (object)

  - `aggregates.all` (integer)

  - `aggregates.metrics` (object)

## Response 400 fields (application/json):

  - `message` (string, required)
    Response message