Metrics

GoHighLevel metrics via API

Your customer connects their GoHighLevel account and your product queries 45 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": "ghl:total_contacts",
      "component": "number_v1",
      "metrics": [
        "total_contacts"
      ],
      "dimensions": [
        "contacts"
      ]
    }
  ]
}
Example: "Total Contacts Created" in October, compared to September.

More GoHighLevel 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

Contacts Over Time

Evolution of new contacts during the 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": "ghl:contacts_over_time",
      "component": "chart_v1",
      "metrics": [
        "new_contacts"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Table

Top Opportunities

List of the highest value opportunities in the 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": "ghl:top_opportunities",
      "component": "datatable_v1",
      "metrics": [
        "value",
        "stage",
        "status",
        "created_at"
      ],
      "dimensions": [
        "opportunity_name"
      ]
    }
  ]
}

Number

New Contacts

Number of new contacts added during the selected 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": "ghl:new_contacts",
      "component": "number_v1",
      "metrics": [
        "new_contacts"
      ],
      "dimensions": [
        "contacts"
      ]
    }
  ]
}

Numbers

26 metrics

  • Total Contacts Created

    Total contacts created up to the current date (all time).

    ghl:total_contacts
  • New Contacts

    Number of new contacts added during the selected period.

    ghl:new_contacts
  • Contacts with Email

    Count of contacts that have an email address registered.

    ghl:contacts_with_email
  • Contacts without Email

    Count of contacts that do not have an email address registered.

    ghl:contacts_without_email
  • Contacts with Phone Number

    Count of contacts that have a phone number registered.

    ghl:contacts_with_phone
  • Contacts without Phone Number

    Count of contacts that do not have a phone number registered.

    ghl:contacts_without_phone
  • Total Opportunities Created

    Total opportunities (deals) created in the period.

    ghl:total_opportunities
  • Opened Opportunities

    The number of opportunities currently with Open status in the selected period.

    ghl:open_opportunities
  • Open Opportunities Value

    Total monetary value of all open opportunities in the selected period.

    ghl:open_value
  • Won Opportunities

    Number of opportunities that were won during the selected period.

    ghl:won_opportunities
  • Lost Opportunities

    Number of opportunities that were lost during the selected period.

    ghl:lost_opportunities
  • Abandoned Opportunities

    The number of opportunities with Abandoned status in the selected period.

    ghl:abandoned_opportunities
  • Total Opportunity Value

    Total monetary value of all opportunities created during the selected period.

    ghl:total_value
  • Won Opportunities Value

    Total monetary value of opportunities that were won during the selected period.

    ghl:won_value
  • Lost Opportunities Value

    Total monetary value of opportunities that were lost during the selected period.

    ghl:lost_value
  • Abandoned Opportunities Value

    Total monetary value of abandoned opportunities in the selected period.

    ghl:abandoned_value
  • Conversion Rate

    Percentage of opportunities that were won versus the total number of opportunities.

    ghl:conversion_rate
  • Win Rate

    Percentage of won opportunities out of all closed opportunities (won + lost). Win Rate = Won ÷ (Won + Lost).

    ghl:win_rate
  • Average Won Opportunity Value

    Average monetary value of opportunities that were won during the selected period.

    ghl:average_won_value
  • Average Time to Close Opportunity

    Average number of days from opportunity creation to closing (won or lost).

    ghl:average_close_time
  • Messages Sent

    Total number of messages (SMS/Email) sent through GoHighLevel during the selected period.

    ghl:messages_sent
  • Total Conversations

    Total number of conversations active during the selected period.

    ghl:total_conversations
  • New Conversations (This Period)

    Number of new conversations started during the selected period.

    ghl:new_conversations
  • Unread Conversations

    Number of conversations that have unread messages.

    ghl:unread_conversations
  • Total Unread Messages

    Total count of unread messages across all conversations.

    ghl:total_unread_messages
  • Total Unassigned Conversations

    Number of conversations not yet assigned to any team member.

    ghl:unassigned_conversations

Charts

12 metrics

  • Contacts Over Time

    Evolution of new contacts during the period.

    ghl:contacts_over_time
  • Opportunities Over Time

    Evolution of the number of opportunities created during the period.

    ghl:opportunities_over_time
  • Value Over Time

    Evolution of total opportunity value during the period.

    ghl:value_over_time
  • Conversations Over Time

    Evolution of the number of conversations during the period.

    ghl:conversations_over_time
  • Opportunities by Pipeline Stage

    Summary of opportunities grouped by pipeline stage.

    ghl:opportunities_by_stage
  • Opportunity Counts by Status

    The number of opportunities grouped by status (open, won, lost, abandoned).

    ghl:opportunities_by_status
  • Contacts by Source

    Distribution of contacts by their acquisition source.

    ghl:contacts_by_source
  • Contacts Count by Tags

    Distribution of contacts grouped by their assigned tags.

    ghl:contacts_by_tags
  • Contacts Count by Type

    Distribution of contacts grouped by contact type.

    ghl:contacts_by_type
  • Contacts by Assigned User

    Contacts mapped to the users they are assigned to.

    ghl:contacts_by_assignee
  • Conversations Distribution by Channel

    Distribution of conversations by channel type (SMS, Email, etc.).

    ghl:conversations_by_type
  • Conversations by Assignee

    Number of conversations assigned to each team member.

    ghl:conversations_by_assignee

Tables

7 metrics

  • Top Opportunities

    List of the highest value opportunities in the period.

    ghl:top_opportunities
  • Opportunities by Pipeline Stage

    Summary of opportunities grouped by pipeline stage.

    ghl:pipeline_by_stage
  • Lost Opportunities by Reason

    Breakdown of lost opportunities by reason for loss.

    ghl:lost_by_reason
  • Top Sources for Contacts Created

    Top sources for contact creation showing count per source.

    ghl:contacts_by_source_table
  • Contacts by Company Name

    Contacts mapped to different company names.

    ghl:contacts_by_company
  • Contacts by Assigned User

    Contacts distributed by the assigned team member.

    ghl:contacts_by_assignee_table
  • Assigned Conversations

    Number of conversations assigned to each team member.

    ghl:conversations_by_assignee_table

See Connect applied to your product.

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