HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
Guides
These docs are for v2022-10-17. Click to read the latest docs for v2024-10-15.

Supported metrics and attributes

Supported attributes

The Query Metric Aggregates API can be filtered and grouped by the following attributes:

  • MESSAGE = "$message"
  • MESSAGE_NAME = "Message Name"
  • MESSAGE_TYPE = "Message Type"
  • ATTRIBUTED_MESSAGE = "$attributed_message"
  • FLOW = "$flow"
  • ATTRIBUTED_FLOW = "$attributed_flow"
  • VARIATION = "$variation"
  • ATTRIBUTED_VARIATION = "$attributed_variation"
  • MESSAGE_SEND_COHORT = "$message_send_cohort"
  • VARIATION_SEND_COHORT = "$variation_send_cohort"
  • CAMPAIGN_CHANNEL = "$campaign_channel"
  • FLOW_CHANNEL = "$flow_channel"
  • ATTRIBUTED_CHANNEL = "$attributed_channel"
  • CAMPAIGN_NAME = "Campaign Name"
  • SUBJECT = "Subject"
  • EMAIL_DOMAIN = "Email Domain"
  • URL = "URL"
  • LIST = "List"
  • FORM_ID = "form_id"
  • METHOD = "Method"
  • CLIENT_CANONICAL = "Client Canonical"
  • CLIENT_NAME = "Client Name"
  • CLIENT_TYPE = "Client Type"
  • BOUNCE_TYPE = "Bounce Type"
  • FAILURE_TYPE = "Failure Type"
  • FAILURE_SOURCE = "Failure Source"
  • FROM_NUMBER = "From Number"
  • FROM_PHONE_REGION = "From Phone Region"
  • TO_NUMBER = "To Number"
  • TO_NUMBER_REGION = "To Phone Region"