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"
]
}
]
}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_contactsNew Contacts
Number of new contacts added during the selected period.
ghl:new_contactsContacts with Email
Count of contacts that have an email address registered.
ghl:contacts_with_emailContacts without Email
Count of contacts that do not have an email address registered.
ghl:contacts_without_emailContacts with Phone Number
Count of contacts that have a phone number registered.
ghl:contacts_with_phoneContacts without Phone Number
Count of contacts that do not have a phone number registered.
ghl:contacts_without_phoneTotal Opportunities Created
Total opportunities (deals) created in the period.
ghl:total_opportunitiesOpened Opportunities
The number of opportunities currently with Open status in the selected period.
ghl:open_opportunitiesOpen Opportunities Value
Total monetary value of all open opportunities in the selected period.
ghl:open_valueWon Opportunities
Number of opportunities that were won during the selected period.
ghl:won_opportunitiesLost Opportunities
Number of opportunities that were lost during the selected period.
ghl:lost_opportunitiesAbandoned Opportunities
The number of opportunities with Abandoned status in the selected period.
ghl:abandoned_opportunitiesTotal Opportunity Value
Total monetary value of all opportunities created during the selected period.
ghl:total_valueWon Opportunities Value
Total monetary value of opportunities that were won during the selected period.
ghl:won_valueLost Opportunities Value
Total monetary value of opportunities that were lost during the selected period.
ghl:lost_valueAbandoned Opportunities Value
Total monetary value of abandoned opportunities in the selected period.
ghl:abandoned_valueConversion Rate
Percentage of opportunities that were won versus the total number of opportunities.
ghl:conversion_rateWin Rate
Percentage of won opportunities out of all closed opportunities (won + lost). Win Rate = Won ÷ (Won + Lost).
ghl:win_rateAverage Won Opportunity Value
Average monetary value of opportunities that were won during the selected period.
ghl:average_won_valueAverage Time to Close Opportunity
Average number of days from opportunity creation to closing (won or lost).
ghl:average_close_timeMessages Sent
Total number of messages (SMS/Email) sent through GoHighLevel during the selected period.
ghl:messages_sentTotal Conversations
Total number of conversations active during the selected period.
ghl:total_conversationsNew Conversations (This Period)
Number of new conversations started during the selected period.
ghl:new_conversationsUnread Conversations
Number of conversations that have unread messages.
ghl:unread_conversationsTotal Unread Messages
Total count of unread messages across all conversations.
ghl:total_unread_messagesTotal 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_timeOpportunities Over Time
Evolution of the number of opportunities created during the period.
ghl:opportunities_over_timeValue Over Time
Evolution of total opportunity value during the period.
ghl:value_over_timeConversations Over Time
Evolution of the number of conversations during the period.
ghl:conversations_over_timeOpportunities by Pipeline Stage
Summary of opportunities grouped by pipeline stage.
ghl:opportunities_by_stageOpportunity Counts by Status
The number of opportunities grouped by status (open, won, lost, abandoned).
ghl:opportunities_by_statusContacts by Source
Distribution of contacts by their acquisition source.
ghl:contacts_by_sourceContacts Count by Tags
Distribution of contacts grouped by their assigned tags.
ghl:contacts_by_tagsContacts Count by Type
Distribution of contacts grouped by contact type.
ghl:contacts_by_typeContacts by Assigned User
Contacts mapped to the users they are assigned to.
ghl:contacts_by_assigneeConversations Distribution by Channel
Distribution of conversations by channel type (SMS, Email, etc.).
ghl:conversations_by_typeConversations 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_opportunitiesOpportunities by Pipeline Stage
Summary of opportunities grouped by pipeline stage.
ghl:pipeline_by_stageLost Opportunities by Reason
Breakdown of lost opportunities by reason for loss.
ghl:lost_by_reasonTop Sources for Contacts Created
Top sources for contact creation showing count per source.
ghl:contacts_by_source_tableContacts by Company Name
Contacts mapped to different company names.
ghl:contacts_by_companyContacts by Assigned User
Contacts distributed by the assigned team member.
ghl:contacts_by_assignee_tableAssigned 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.
