List analytics keys

List keys for a hosted Chunkify Analytics server: the public key used by players to send events, and read-only secret key records for dashboard and MCP access. Secret values are not returned. Requires a team owner and a Team Access Key.

GET

/projects/{projectId}/analytics/connections/{connectionId}/keys

Authorization

Authorization

header

string

required

Enter the team access token with the Bearer prefix, e.g. "Bearer team_access_token"

Path Parameters

projectId

string

required

The owning Chunkify project ID.

connectionId

string

required

The saved analytics connection ID.

Responses

application/json

data

object[]

required

status

"success"

string

required

Analytics keys.

application/json

error

object

required

status

"error"

string

required

Status indicates the response status "error"

Validation error.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Forbidden error.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

NotFound error.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

The name is already used, setup is incomplete, or deletion needs reconciliation.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

The analytics server is unavailable or returned an incompatible response.

import Chunkify from '@chunkify/chunkify';

const client = new Chunkify({
  teamAccessToken: 'My Team Access Token',
});

const result = await client.projects.analytics.connections.keys.list(
  'proj_example',
  'anc_example',
);

from chunkify import Chunkify

client = Chunkify(
    team_access_token="My Team Access Token",
)

result = client.projects.analytics.connections.keys.list(
    "proj_example",
    "anc_example",
)

<?php

use Chunkify\Client;

$client = new Client(
    teamAccessToken: 'My Team Access Token',
);

$result = $client->projects->analytics->connections->keys->list(
    'proj_example',
    'anc_example',
);

package main

import (
	"context"
	"github.com/chunkifydev/chunkify-go"
	"github.com/chunkifydev/chunkify-go/option"
)

func main() {
	client := chunkify.NewClient(
		option.WithTeamAccessToken("My Team Access Token"),
	)
	_, err := client.Projects.Analytics.Connections.Keys.List(
		context.TODO(),
		"proj_example",
		"anc_example",
	)
	if err != nil {
		panic(err)
	}
}

{
  "data": [
    {
      "id": "<string>",
      "purpose": "player"
    }
  ],
  "status": "success"
}
{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "type": "ValidationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 403,
    "message": "Unauthorized to perform this action",
    "type": "ForbiddenError"
  },
  "status": "error"
}
{
  "error": {
    "code": 404,
    "message": "Ressource not found",
    "type": "NotFoundError"
  },
  "status": "error"
}
{
  "error": {
    "code": 409,
    "message": "source_unavailable: the original video is no longer accessible",
    "type": "ConflictError"
  },
  "status": "error"
}
{
  "error": {
    "code": 503,
    "message": "The service is temporarily unavailable; retry the request",
    "type": "ServiceUnavailableError"
  },
  "status": "error"
}

# List analytics keys > List keys for a hosted Chunkify Analytics server: the public key used by players to send events, and read-only secret key records for dashboard and MCP access. Secret values are not returned. Requires a team owner and a Team Access Key. ```json { "path": "/projects/{projectId}/analytics/connections/{connectionId}/keys", "method": "get", "schema": { "description": "List keys for a hosted Chunkify Analytics server: the public key used by players to send events, and read-only secret key records for dashboard and MCP access. Secret values are not returned. Requires a team owner and a Team Access Key.", "operationId": "listAnalyticsKeys", "parameters": [ { "description": "The owning Chunkify project ID.", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "The saved analytics connection ID.", "in": "path", "name": "connectionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsKeyListResponse" } } }, "description": "Analytics keys." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorValidation" } } }, "description": "Validation error." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorForbidden" } } }, "description": "Forbidden error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorNotFound" } } }, "description": "NotFound error." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorConflict" } } }, "description": "The name is already used, setup is incomplete, or deletion needs reconciliation." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorServiceUnavailable" } } }, "description": "The analytics server is unavailable or returned an incompatible response." } }, "security": [ { "TeamAccessToken": [] } ], "summary": "List analytics keys", "tags": [ "Analytics Connections" ], "x-codeSamples": [ { "lang": "typescript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n teamAccessToken: 'My Team Access Token',\n});\n\nconst result = await client.projects.analytics.connections.keys.list(\n 'proj_example',\n 'anc_example',\n);\n" }, { "lang": "python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n team_access_token=\"My Team Access Token\",\n)\n\nresult = client.projects.analytics.connections.keys.list(\n \"proj_example\",\n \"anc_example\",\n)\n" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n teamAccessToken: 'My Team Access Token',\n);\n\n$result = $client-\u003eprojects-\u003eanalytics-\u003econnections-\u003ekeys-\u003elist(\n 'proj_example',\n 'anc_example',\n);\n" }, { "lang": "golang", "source": "package main\n\nimport (\n\t\"context\"\n\t\"github.com/chunkifydev/chunkify-go\"\n\t\"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n\tclient := chunkify.NewClient(\n\t\toption.WithTeamAccessToken(\"My Team Access Token\"),\n\t)\n\t_, err := client.Projects.Analytics.Connections.Keys.List(\n\t\tcontext.TODO(),\n\t\t\"proj_example\",\n\t\t\"anc_example\",\n\t)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n}\n" } ] } } ``` ```json #/components/schemas/ResponseErrorForbidden { "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 403, "description": "Code is the HTTP status code", "examples": [ 403 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Unauthorized to perform this action" ], "type": "string" }, "type": { "const": "ForbiddenError", "description": "Type indicates the error category", "enum": [ "ForbiddenError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/ResponseErrorNotFound { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 404, "description": "Code is the HTTP status code", "examples": [ 404 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Ressource not found" ], "type": "string" }, "type": { "const": "NotFoundError", "description": "Type indicates the error category", "enum": [ "NotFoundError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorConflict { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 409, "description": "Code is the HTTP status code", "examples": [ 409 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "source_unavailable: the original video is no longer accessible" ], "type": "string" }, "type": { "const": "ConflictError", "description": "Type indicates the error category", "enum": [ "ConflictError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorServiceUnavailable { "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 503, "description": "Code is the HTTP status code", "examples": [ 503 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "The service is temporarily unavailable; retry the request" ], "type": "string" }, "type": { "const": "ServiceUnavailableError", "description": "Type indicates the error category", "enum": [ "ServiceUnavailableError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/AnalyticsKeyListResponse { "properties": { "data": { "items": { "$ref": "#/components/schemas/AnalyticsKey" }, "type": "array" }, "status": { "const": "success", "type": "string" } }, "required": [ "status", "data" ], "type": "object" } ``` ```json #/components/schemas/AnalyticsKey { "description": "One key per purpose. Public player values remain available; read and MCP values are returned only on creation or rotation.", "properties": { "id": { "description": "Id identifies this key in the collector.", "type": "string" }, "public_key": { "description": "PublicKey is the browser ingestion credential for a player key. Omitted for read-only API and MCP keys, whose secret values are shown once.", "type": "string" }, "purpose": { "description": "Purpose distinguishes player ingestion, read-only API access and a separate read-only MCP credential. Read and MCP keys have the same collector permissions.", "enum": [ "player", "read", "mcp" ], "type": "string" } }, "required": [ "id", "purpose" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorValidation { "properties": { "error": { "properties": { "code": { "const": 400, "description": "Code is the HTTP status code", "examples": [ 400 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Invalid request parameters" ], "type": "string" }, "type": { "const": "ValidationError", "description": "Type indicates the error category", "enum": [ "ValidationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/ResponseErrorAuthentication { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 401, "description": "Code is the HTTP status code", "examples": [ 401 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Authentication error: invalid token or subscription inactive" ], "type": "string" }, "type": { "const": "AuthenticationError", "description": "Type indicates the error category", "enum": [ "AuthenticationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ```