{
"openapi": "3.0.2",
"info": {
"title": "Klaviyo API (Beta)",
"version": "2026-07-15.pre",
"description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
"contact": {
"name": "Klaviyo Developer Experience Team",
"email": "developers@klaviyo.com",
"url": "https://developers.klaviyo.com"
},
"termsOfService": "https://www.klaviyo.com/legal/api-terms",
"license": {
"name": "License",
"url": "https://www.klaviyo.com/legal"
}
},
"servers": [
{
"url": "https://a.klaviyo.com",
"description": "Production"
}
],
"security": [
{
"Klaviyo-API-Key": []
}
],
"paths": {
"/api/customer-agent-skill-values-reports": {
"post": {
"operationId": "query_customer_agent_skill_values_beta",
"summary": "Query Customer Agent Skill Values",
"description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nReturns per-skill aggregates across the requested timeframe.\n\nEach row of ``results`` is one skill bucket with a computed ``volume`` statistic. Counts are at the invocation level: one conversation that runs multiple skills contributes to multiple buckets.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`agents:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/query_customer_agent_skill_values_beta.json)",
"parameters": [
{
"name": "fields[customer-agent-skill-values-report]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"results"
]
}
},
"explode": false
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2026-07-15.pre"
}
}
],
"requestBody": {
"description": "Request body for the skill-values-report endpoint.",
"required": true,
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportQueryRequestDataWrapper"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportResponseDataWrapper"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Beta APIs"
],
"x-klaviyo-operation-aliases": [
"create_customer_agent_skill_values_report"
],
"x-klaviyo-pre-release": "BETA",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"agents:read"
],
"x-klaviyo-subtag": "Customer Agent"
}
}
},
"components": {
"responses": {
"ClientError": {
"description": "Client Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
},
"ServerError": {
"description": "Server Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
}
},
"schemas": {
"CustomerAgentSkillValuesReportQueryRequest": {
"type": "object",
"properties": {
"statistics": {
"description": "Metrics to compute for each skill bucket. Currently only volume is supported.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillStatistic"
}
},
"groupings": {
"description": "Required grouping. Each result row corresponds to one skill.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillGrouping"
}
},
"timeframe": {
"description": "Time window for the report.",
"allOf": [
{
"$ref": "#/components/schemas/ReportTimeframeRequest"
}
]
},
"filter": {
"description": "Optional Klaviyo filter syntax. Use any(skill,[...]) to narrow to specific skills; use any(channel,[...]) to narrow by channel. When omitted, returns aggregates for every skill the company has used in the timeframe.",
"type": "string",
"example": "any(skill,[\"product_qa\",\"order_status\"]),any(channel,[\"web-chat\"])",
"nullable": true
}
},
"required": [
"statistics",
"groupings",
"timeframe"
]
},
"CustomerAgentSkillValuesReportQueryRequestData": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportResourceName"
},
"attributes": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportQueryRequest"
}
},
"required": [
"type",
"attributes"
]
},
"CustomerAgentSkillValuesReportQueryRequestDataWrapper": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportQueryRequestData"
}
},
"required": [
"data"
]
},
"CustomerAgentSkillValuesReportResourceName": {
"type": "string",
"enum": [
"customer-agent-skill-values-report"
]
},
"CustomerAgentSkillValuesReportResponse": {
"type": "object",
"properties": {
"results": {
"description": "Computed skill-values-report rows.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValuesData"
}
}
},
"required": [
"results"
]
},
"CustomerAgentSkillValuesReportResponseData": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportResourceName"
},
"id": {
"description": "Opaque identifier for the skill-values report response.",
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportResponse"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"CustomerAgentSkillValuesReportResponseDataWrapper": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CustomerAgentSkillValuesReportResponseData"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"ReportTimeframeRequest": {
"type": "object",
"properties": {
"key": {
"description": "Named preset window.",
"type": "string",
"enum": [
"today",
"yesterday",
"this_week",
"last_week",
"last_7_days",
"last_30_days",
"last_90_days",
"this_month",
"last_month"
],
"nullable": true
},
"start": {
"description": "ISO-8601 lower-bound (inclusive) for the report window.",
"type": "string",
"format": "date-time",
"example": "2026-05-01T00:00:00+00:00",
"nullable": true
},
"end": {
"description": "ISO-8601 upper-bound (exclusive) for the report window.",
"type": "string",
"format": "date-time",
"example": "2026-06-01T00:00:00+00:00",
"nullable": true
}
}
},
"SkillGrouping": {
"description": "Required bucket dimension supported by the skill-values report.\n\nThe spec requires exactly one grouping, and it must be ``skill``.",
"type": "string",
"enum": [
"skill"
]
},
"SkillStatistic": {
"description": "Metrics computable for each skill bucket.",
"type": "string",
"enum": [
"volume"
]
},
"ValuesData": {
"type": "object",
"properties": {
"groupings": {
"description": "Bucket-identifying values for this row. Empty when the request omits groupings for a single aggregate row.",
"type": "object"
},
"statistics": {
"description": "Computed metrics for this row. Only the statistics named in the request appear here.",
"type": "object"
}
},
"required": [
"groupings",
"statistics"
]
}
},
"securitySchemes": {
"Klaviyo-API-Key": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Beta APIs",
"description": "beta apis"
}
]
}