--- title: "Retrieve a metric card by slug" method: GET path: "/api/metric-cards/{slug}" tags: ["Metric Cards"] --- # Retrieve a metric card by slug `GET /api/metric-cards/{slug}` ## Path parameters - `slug` string, required ## Response `200` The requested metric card - MetricCard - `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. - `category` string, required — Metric category. - `title` string, required — Display name. - `status` 'published' | 'deprecated', required - `definition_revised_at` string, required — Date the public content was last revised (YYYY-MM-DD). - `public` MetricCardPublic, required - `definition` string, required — Plain-text metric definition. - `formula` string, required — Plain-text formula. - `computation_logic` string[], required — Plain-text computation-logic entries, one per bullet. - `api` MetricCardApiMapping - `scope` string, required — The /stats discriminated-union scope variant for this metric. - `measures` string[] — Measures to request on the scope. - `dimensions` string[] — Dimensions to request on the scope. - `filters` MetricCardApiFilter[] — Filters the caller must include to disambiguate this metric. - `member` string, required — Filter member to include on the /stats request. - `values` string[], required — Values to match (implicit `one-of` operator). - `aliases` string[], required — Previous slugs that still resolve to this card. - `related` MetricCardRef[], required — Related metric cards. - `slug` string, required — Slug of the referenced metric card. - `url` string, required — Relative URL of the referenced metric card. - `replaces` MetricCardRef[], required — Metric cards this one replaces. - `slug` string, required — Slug of the referenced metric card. - `url` string, required — Relative URL of the referenced metric card. - `used_in_reports` string[], required — Report views where this metric is surfaced. - `used_in_reports_links` string[] — Direct report/dashboard URLs (relative paths) where this metric is surfaced. ## Other responses - `404` — No metric card was found for the given slug. The error `data` includes the requested `slug` and a `did_you_mean` list of the closest known slugs. - `503` — The analytics service is unavailable or timed out. --- [API](https://skmtc.net/gorgias/apis/gorgias-rest-api.md) · [All operations](https://skmtc.net/gorgias/apis/gorgias-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gorgias/gorgias-rest-api/versions/36f2e31f4e81/schema)