Retrieve graph of messages sent by landing category for a given account

​

Returns the number of messages sent by a given account that landed in the requested category (e.g. INBOX, SPAM) over the requested time window, grouped by day. Consolidated data is returned up to 2 days ago.

Path Parameters
  • account_id
    Type: integerFormat: int32
    required

    Internal ID of the account.

  • cat
    Type: stringenum
    required

    Landing category to graph. INBOX groups INBOX, PERSONAL and IMPORTANT. CATEGORIES groups PROMOTION, SOCIAL, UPDATES and FORUMS. SPAM returns spam. OTHERS returns every other landing location.

    values
    • INBOX
    • CATEGORIES
    • SPAM
    • OTHERS
Query Parameters
  • provider
    Type: stringenum

    Filter the graph by recipient provider. One of gmail, outlook or others. When omitted, all providers are included.

    values
    • gmail
    • outlook
    • others
  • past_days
    Type: integerFormat: int32
    min:  
    0
    max:  
    180

    Number of past days to include in the graph. Maximum is 180.

Responses
  • application/json
  • application/json
Request Example for get/v1/conversation_message_logs/{account_id}/sent/categories/graph/{cat}
curl 'http://api.mailreach.co/api/v1/conversation_message_logs/1234/sent/categories/graph/INBOX?provider=gmail&past_days=14' \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN'

{
  "labels": [
    "Apr 10",
    "Apr 11",
    "Apr 12",
    "Today"
  ],
  "data": [
    65,
    74,
    59,
    26
  ],
  "consolidated": true
}

Daily-bucketed graph of messages sent that landed in the requested category. consolidated is omitted when consolidated stats are not yet available for the account.