Metrics

E-goi metrics via API

Your customer connects their E-goi account and your product queries 26 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "egoi:total_contacts",
      "component": "number_v1",
      "metrics": [
        "total_contacts"
      ],
      "dimensions": [
        "contact"
      ]
    }
  ]
}
Example: "Total contacts" in October, compared to September.

More E-goi request examples

The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).

Chart

Email campaigns over time

Performance of your email campaigns over the analyzed period.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "egoi:email_campaigns_over_time",
      "component": "chart_v1",
      "metrics": [
        "sent_emails",
        "unique_email_openings",
        "clicks"
      ],
      "dimensions": [
        "email"
      ]
    }
  ]
}

Table

Contacts performance table

Table of contacts present, subscriptions, and removals.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "egoi:contacts_performance_table",
      "component": "datatable_v1",
      "metrics": [
        "total_subscriptions",
        "total_subscriptions_rate",
        "total_unsubscriptions",
        "total_unsubscriptions_rate",
        "total_contacts"
      ],
      "dimensions": [
        "contact"
      ]
    }
  ]
}

Number

Total subscriptions

Total number of subscriptions to your contact list (via forms, API, or manually added) during the analyzed period.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "egoi:total_subscriptions",
      "component": "number_v1",
      "metrics": [
        "total_subscriptions"
      ],
      "dimensions": [
        "contact"
      ]
    }
  ]
}

Numbers

20 metrics

  • Total contacts

    Total number of contacts present in your account.

    egoi:total_contacts
  • Total subscriptions

    Total number of subscriptions to your contact list (via forms, API, or manually added) during the analyzed period.

    egoi:total_subscriptions
  • Total unsubscriptions

    Total number of contacts removed from your account.

    egoi:total_unsubscriptions
  • Sent emails

    Total number of emails sent by campaigns during the analyzed period.

    egoi:sent_emails
  • Total opened emails

    Number of times emails were opened by recipients.

    egoi:total_email_openings
  • Unique opened emails

    Number of times emails were opened by recipients.

    egoi:unique_email_openings
  • Clicks

    Total number of clicks that occurred on links embedded in the sent emails.

    egoi:clicks
  • Unique clicks

    Number of unique recipients who clicked on any tracked link.

    egoi:unique_clicks
  • Hard bounces

    Number of permanent failures in email delivery.

    egoi:hard_bounces
  • Soft bounces

    Number of temporary failures in email delivery.

    egoi:soft_bounces
  • Complaints

    Number of complaints received about your email campaigns during the analyzed period.

    egoi:complaints
  • Email unsubscriptions

    Indicates how many recipients opted to be removed from the email list during the analyzed period.

    egoi:email_unsubscriptions
  • Opened emails rate

    Percentage of total email opens relative to total emails sent.

    egoi:email_openings_rate
  • Unique opened emails rate

    Percentage of unique email opens relative to total emails delivered.

    egoi:unique_email_openings_rate
  • Clicks rate

    Total percentage of clicks, considering all clicks made on email links relative to the total number of emails sent.

    egoi:clicks_rate
  • Unique clicks rate

    Percentage of unique clicks on your emails relative to the total emails that were opened at least once.

    egoi:unique_clicks_rate
  • Hard bounces rate

    Percentage of permanent failures in email delivery.

    egoi:hard_bounces_rate
  • Complaints rate

    Percentage of complaints received about your email campaigns during the analyzed period.

    egoi:complaints_rate
  • Email unsubscriptions rate

    Percentage of recipients who opted to be removed from the email list during the analyzed period.

    egoi:email_unsubscriptions_rate
  • Delivered emails

    Indicates how many emails were successfully delivered to recipients, excluding bounces.

    egoi:delivered_emails

Charts

1 metric

  • Email campaigns over time

    Performance of your email campaigns over the analyzed period.

    egoi:email_campaigns_over_time

Tables

5 metrics

  • Contacts performance table

    Table of contacts present, subscriptions, and removals.

    egoi:contacts_performance_table
  • Email campaign performance

    Table of email campaign performance.

    egoi:email_campaign_performance
  • SMS performance

    Table of SMS campaign performance.

    egoi:sms_performance
  • Web push performance

    Table of web push campaign performance.

    egoi:web_push_performance
  • Automation performance

    Table of automation performance.

    egoi:automation_performance

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.