Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Metric Cards

Retrieve a metric card by slug

get/api/metric-cards/{slug}

Path parameters

slugstring required

Response

The requested metric card

slug'abandoned-calls' | 'accuracy' | 'achievement-rate' | 'agents-offline' | 'agents-online' | 'ai-agent-automation-rate' | 'ai-agent-average-csat' | 'ai-agent-closed-tickets' | 'all-used-tags-all' | 'all-used-tags-all-created' | 'all-used-values' | 'all-used-values-created' | 'article-views' | 'assigned-open-tickets' | 'automated-interactions' | 'average-csat' | 'average-discount-amount' | 'average-order-value' | 'average-survey-score' | 'average-talk-time' | 'average-ticket-handle-time' | 'average-wait-time' | 'brand-voice' | 'buy-through-rate' | 'callback-requests' | 'calls-in-queue' | 'cancelled-calls' | 'click-through-rate' | 'closed-tickets' | 'closed-tickets-per-hour' | 'comment-highlights' | 'communication-skills' | 'contribution-to-total-sales' | 'conversion-rate' | 'cost-saved' | 'coverage-rate' | 'created-tickets' | 'decrease-in-frt' | 'decrease-in-resolution-time' | 'discount-codes-applied' | 'discount-usage' | 'discounts-offered' | 'efficiency' | 'first-response-time' | 'handover-interactions' | 'human-response-time-after-ai-handoff' | 'inbound-answered-per-agent' | 'inbound-calls' | 'inbound-declined' | 'inbound-transferred' | 'internal-compliance' | 'language-proficiency' | 'live-messages-sent' | 'live-online-status' | 'live-open-tickets' | 'live-tickets-closed' | 'live-tickets-created' | 'live-tickets-replied' | 'median-purchase-time' | 'median-response-time' | 'messages-per-ticket' | 'messages-received' | 'messages-sent' | 'messages-sent-per-hour' | 'messages-sent-per-macro' | 'missed-calls' | 'no-search-results-search-count' | 'one-touch-tickets' | 'online-time' | 'open-tickets' | 'orders-influenced' | 'outbound-calls' | 'overall-automation-rate' | 'percent-abandoned-calls' | 'percent-callback-requests' | 'percent-cancelled-calls' | 'percent-missed-calls' | 'percent-sla-achievement-rate' | 'percentage-of-closed-tickets' | 'percentage-of-created-tickets' | 'performance-per-article-views' | 'product-recommendations' | 'resolution-completeness' | 'resolution-time' | 'response-rate' | 'revenue-per-interaction' | 'reviewed-tickets' | 'satisfaction-score' | 'search-results' | 'search-terms-with-results-articles-clicked' | 'search-terms-with-results-click-through-rate' | 'search-terms-with-results-search-count' | 'searches' | 'sla-achievement-rate' | 'success-rate' | 'surveys-sent' | 'ticket-handle-time-per-agent' | 'tickets-replied' | 'tickets-replied-per-hour' | 'tickets-with-achieved-slas' | 'tickets-with-breached-slas' | 'time-saved-by-agent' | 'top-performer-frt' | 'top-performers-closed-tickets' | 'top-performers-csat' | 'top-performers-resolution-time' | 'top-used-tags-all' | 'top-used-tags-all-created' | 'top-used-tags-all-created-trend' | 'top-used-tags-all-trend' | 'top-used-values' | 'top-used-values-created' | 'top-used-values-created-trend' | 'top-used-values-trend' | 'total-calls' | 'total-sales' | 'unanswered-calls' | 'unassigned-open-tickets' | 'wait-time-per-call' | 'zero-touch-tickets' required

The slugs gorgias exposes, mirroring the published + deprecated cards in the analytics repo.

gorgias owns this list as the public contract: it is enumerated in the OpenAPI spec, gates which cards the list/detail endpoints surface, and validates the get-by-slug path parameter. It is a point-in-time snapshot of analytics/docs/metrics (status: published | deprecated) and MUST be updated (here) whenever a card is added, renamed, deprecated, or removed in analytics — a new card is not exposed through gorgias until this enum ships. SearchMetricCardsUseCase logs + counts any slug analytics returns that is missing here, so a forgotten update surfaces as a Datadog signal.

categorystring required

Metric category.

titlestring required

Display name.

status'published' | 'deprecated' required
definition_revised_atstring required

Date the public content was last revised (YYYY-MM-DD).

aliasesstring[] required

Previous slugs that still resolve to this card.

used_in_reportsstring[] required

Report views where this metric is surfaced.

used_in_reports_linksstring[]

Direct report/dashboard URLs (relative paths) where this metric is surfaced.