# 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

  - `duration` (string, required)
    A duration in the format of '1d' '2h'. If duration is provided then it is calculated from the end date and overwrites the start date.

  - `events` (array)
    The set of events to include.
    Enum: "accepted", "delivered", "failed", "opened", "unique_opened", "clicked", "unique_clicked", "unsubscribed", "complained", "rejected", "stored", "email_validation", "list_uploaded", "list_member_uploaded", "list_member_upload_error", "trapped"

  - `metric_events` (array)
    Optional set of analytics metric events. Will be converted into corresponding events.
    Enum: "accepted_incoming", "accepted_outgoing", "accepted", "delivered_smtp", "delivered_http", "delivered_optimized", "delivered", "stored", "opened", "clicked", "unique_opened", "unique_clicked", "complained", "unsubscribed", "failed", "processed", "sent", "temporary_failed", "permanent_failed", "esp_block", "temporary_failed_esp_block", "permanent_failed_esp_block", "webhook_failure", "permanent_failed_optimized", "permanent_failed_old", "bounced", "hard_bounces", "soft_bounces", "delayed_bounce", "suppressed_bounces", "suppressed_unsubscribed", "suppressed_complaints", "delivered_first_attempt", "delivered_subsequent", "delivered_two_plus_attempts", "delayed_first_attempt"

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

  - `filter.AND` (array, required)

  - `filter.AND.attribute` (string, required)
    Filter Attribute
    Enum: "id", "domain", "ip", "ip_pool", "recipient_domain", "recipient_provider", "country", "bot", "device", "subaccount", "event", "attachment_filename", "from", "message_id", "subject", "mailing_list_address", "to", "size", "recipient", "tag", "severity", "user_variables", "delivered_at", "delivery_status_code", "delivery_status_bounce_type", "delivery_status_message", "is_routed", "i_classification_rule_id", "i_classification_group_id", "recipients"

  - `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` (any)

  - `items.campaigns` (array)

  - `items.campaigns.id` (string)

  - `items.campaigns.name` (string)

  - `items.tags` (array)

  - `items.method` (string)

  - `items.originating-ip` (string)

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

  - `items.delivered-at` (string)

  - `items.delivery-status` (any)

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

  - `items.domain` (any, required)

  - `items.recipient` (string)

  - `items.recipient-domain` (string)

  - `items.recipient-provider` (string)

  - `items.envelope` (any)

  - `items.storage` (any)

  - `items.template` (any)

  - `items.log-level` (string)

  - `items.user-variables` (string)

  - `items.message` (any)

  - `items.flags` (any)

  - `items.primary-dkim` (string)

  - `items.ip` (string)

  - `items.geolocation` (any)

  - `items.client-info` (any)

  - `items.severity` (string)

  - `items.reason` (string)

  - `items.routes` (any)

  - `items.mailing-list` (any)

  - `items.url` (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