# List Recipient Statistics

Retrieve a list of overall aggregated delivery and engagement statistics for all list recipients. A list recipient object manages the relationship between a contact and a contactslist - every instance of a contact being added to a list creates a new list recipient.

Endpoint: GET /v3/REST/listrecipientstatistics
Version: 1.0.0
Security: basicAuth

## Query parameters:

  - `Blocked` (boolean)
    When true, will retrieve statistics only for list recipients that have blocked messages. When false, contacts with blocked messages will be excluded from the response.

  - `Bounced` (boolean)
    When true, will retrieve statistics only for list recipients that have bounced messages. When false, contacts with bounced messages will be excluded from the response.

  - `Click` (boolean)
    When true, will retrieve statistics only for list recipients that have messages with registered clicks. When false, contacts with clicked messages will be excluded from the response.

  - `Contact` (integer)
    Retrieves only list recipient statistics for the specified contact ID.

  - `ContactsList` (integer)
    Retrieves statistics only for list recipients that are part of the specified contact list ID.

  - `IsExcludedFromCampaigns` (boolean)
    When true, will retrieve statistics only for recipients linked to contacts that have been excluded from campaigns. When false, only recipients who are not linked to excluded contacts will be part of the response.

  - `IsUnsubscribed` (boolean)
    When true, will retrieve statistics only for unsubscribed list recipients. When false, unsubscribed recipients will be excluded from the response.

  - `LastActivityAt` (string)
    Retrieves statistics only for list recipients, for which LastActivityAt (their last received email, open, click etc.) equals the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

  - `MaxLastActivityAt` (string)
    Retrieves statistics only for list recipients, for which LastActivityAt (their last received email, open, click etc.) is before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

  - `MaxUnsubscribedAt` (string)
    Retrieves statistics only for list recipients, for which UnsubscribedAt (the time they unsubscribed) is before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

  - `MinLastActivityAt` (string)
    Retrieves statistics only for list recipients, for which LastActivityAt (their last received email, open, click etc.) is after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

  - `MinUnsubscribedAt` (string)
    Retrieves statistics only for list recipients, for which UnsubscribedAt (the time they unsubscribed) is after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

  - `Open` (boolean)
    When true, will retrieve statistics only for list recipients that have messages with registered opens. When false, contacts with opened messages will be excluded from the response.

  - `Queued` (boolean)
    When true, will retrieve statistics only for contacts that have queued messages. When false, contacts with queued messages will be excluded from the response.

  - `Sent` (boolean)
    When true, will retrieve statistics only for list recipients that have sent messages. When false, contacts with sent messages will be excluded from the response.

  - `ShowExtraData` (boolean)
    When true, will display the contact properties associated with this list recipient in the "Data" array object in the response.

Default value: false

  - `Spam` (boolean)
    When true, will retrieve statistics only for list recipients that have messages marked as Spam. When false, contacts with Spam messages will be excluded from the response.

  - `TimeZone` (string)
    Selects the time zone for this user.

  - `Unsubscribed` (boolean)
    When true, will retrieve statistics only for list recipients that have unsubscribed from a list at least once. When false, contacts with unsubscribe events will be excluded from the response.

## Response 200 fields (application/json):

  - `Count` (integer)
    Indicates the number of objects in the Data array.

  - `Data` (array)
    A JSON array containing a list of objects returned by this endpoint.

  - `Data.BlockedCount` (integer)
    Number of blocked messages.

  - `Data.BouncedCount` (integer)
    Number of bounced messages.

  - `Data.ClickedCount` (integer)
    Number of clicked messages.

  - `Data.Data` (array)
    A JSON array containing contact properties and their values. Data information will be shown if the ShowExtraData query parameter is set to true.

  - `Data.Data.Name` (string)
    Name of this contact property.

  - `Data.Data.Value` (string)
    Value of this contact property for this contact.

  - `Data.DeferredCount` (integer)
    Number of deferred messages - ones that could not be delivered and the system is retrying to send. If after 3 days the sending is unsuccessful, those messages become soft-bounced.

  - `Data.DeliveredCount` (integer)
    Number of messages delivered to their destination.

  - `Data.HardbouncedCount` (integer)
    Number of hard-bounced messages.

  - `Data.LastActivityAt` (string)
    Timestamp indicating the last registered activity for this list recipient.

  - `Data.ListRecipientID` (integer)
    Unique numeric ID for this list recipient.

  - `Data.OpenedCount` (integer)
    Number of opened messages.

  - `Data.PreQueuedCount` (integer)
    Number of pre-queued messages.

  - `Data.ProcessedCount` (integer)
    Number of processed messages.

  - `Data.QueuedCount` (integer)
    Number of queued messages.

  - `Data.SoftbouncedCount` (integer)
    Number of soft-bounced messages.

  - `Data.SpamComplaintCount` (integer)
    Number of messages marked as Spam by the recipients.

  - `Data.UnsubscribedCount` (integer)
    Number of registered unsubscribe requests.

  - `Data.WorkFlowExitedCount` (integer)
    Number of registered automation workflow exits.

  - `Total` (integer)
    Indicates the number of objects in the Data array.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields