# Post query to get account metrics

Gets filtered metrics for an account

Endpoint: POST /v1/analytics/metrics
Version: 3.0.0
Security: basicAuth

## Request fields (application/json):

  - `start` (string, required)
    A start date (default: 7 days before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14

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

  - `resolution` (string, required)
    A resolution in the format of 'day' 'hour' 'month'. Default is day.

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

  - `dimensions` (array, required)
    Attributes of the metric data such as 'subaccount'.

  - `metrics` (array, required)
    Name of the metrics to receive the stats for such as 'processed_count'.

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

  - `filter.AND` (array, required)

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

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

  - `filter.AND.values` (array)

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

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

  - `include_subaccounts` (boolean, required)
    Include stats from all subaccounts.

  - `include_aggregates` (boolean, required)
    Include top-level aggregate metrics.

## Response 200 fields (application/json):

  - `start` (string)

  - `end` (string)

  - `resolution` (string)

  - `duration` (string)

  - `dimensions` (array)

  - `pagination` (object)

  - `pagination.sort` (string, required)
    Colon-separated value indicating column name and sort direction e.g. 'domain:asc'.

  - `pagination.skip` (integer, required)
    The number of items to skip over when satisfying the request. To get the first page of data set skip to zero.  Then increment the skip by the limit for subsequent calls.

  - `pagination.limit` (integer, required)
    The maximum number of items returned in the response.

  - `pagination.total` (integer, required)
    The total number of items in the query result set.

  - `items` (array, required)

  - `items.metrics` (object)

  - `items.metrics.accepted_incoming_count` (integer)

  - `items.metrics.accepted_outgoing_count` (integer)

  - `items.metrics.accepted_count` (integer)

  - `items.metrics.delivered_smtp_count` (integer)

  - `items.metrics.delivered_http_count` (integer)

  - `items.metrics.delivered_optimized_count` (integer)

  - `items.metrics.delivered_count` (integer)

  - `items.metrics.stored_count` (integer)

  - `items.metrics.processed_count` (integer)

  - `items.metrics.sent_count` (integer)

  - `items.metrics.opened_count` (integer)

  - `items.metrics.clicked_count` (integer)

  - `items.metrics.unique_opened_count` (integer)

  - `items.metrics.unique_clicked_count` (integer)

  - `items.metrics.unsubscribed_count` (integer)

  - `items.metrics.complained_count` (integer)

  - `items.metrics.failed_count` (integer)

  - `items.metrics.temporary_failed_count` (integer)

  - `items.metrics.permanent_failed_count` (integer)

  - `items.metrics.temporary_failed_esp_block_count` (integer)
    Use instead of esp_block_count.

  - `items.metrics.permanent_failed_esp_block_count` (integer)

  - `items.metrics.rate_limit_count` (integer)

  - `items.metrics.webhook_count` (integer)

  - `items.metrics.permanent_failed_optimized_count` (integer)

  - `items.metrics.permanent_failed_old_count` (integer)

  - `items.metrics.bounced_count` (integer)

  - `items.metrics.hard_bounces_count` (integer)

  - `items.metrics.soft_bounces_count` (integer)

  - `items.metrics.delayed_bounce_count` (integer)

  - `items.metrics.suppressed_bounces_count` (integer)

  - `items.metrics.suppressed_unsubscribed_count` (integer)

  - `items.metrics.suppressed_complaints_count` (integer)

  - `items.metrics.delivered_first_attempt_count` (integer)

  - `items.metrics.delayed_first_attempt_count` (integer)

  - `items.metrics.delivered_subsequent_count` (integer)

  - `items.metrics.delivered_two_plus_attempts_count` (integer)

  - `items.metrics.delivered_rate` (string)

  - `items.metrics.opened_rate` (string)

  - `items.metrics.clicked_rate` (string)

  - `items.metrics.unique_opened_rate` (string)

  - `items.metrics.unique_clicked_rate` (string)

  - `items.metrics.unsubscribed_rate` (string)

  - `items.metrics.complained_rate` (string)

  - `items.metrics.bounce_rate` (string)

  - `items.metrics.fail_rate` (string)

  - `items.metrics.permanent_fail_rate` (string)

  - `items.metrics.temporary_fail_rate` (string)

  - `items.metrics.delayed_rate` (string)

  - `aggregates` (object)

## Response 400 fields (application/json):

  - `message` (string, required)
    Response message