Get Metadata Grouped Data

Get metadata key based grouped data.

get

Authorizations

Path parameters

metadataKeystringRequired

Query parameters

time_of_generation_minstring · date-timeRequired

Minimum time of generation (ISO8601 format)

Example: 2024-08-23T15:50:23+05:30

time_of_generation_maxstring · date-timeRequired

Maximum time of generation (ISO8601 format)

Example: 2024-08-23T15:50:23+05:30

total_units_minintegerOptional

Minimum total units (tokens)

total_units_maxintegerOptional

Maximum total units (tokens)

cost_minnumberOptional

Minimum cost (in cents)

cost_maxnumberOptional

Maximum cost (in cents)

prompt_token_minintegerOptional

Minimum number of prompt tokens

prompt_token_maxintegerOptional

Maximum number of prompt tokens

completion_token_minintegerOptional

Minimum number of completion tokens

completion_token_maxintegerOptional

Maximum number of completion tokens

status_codestringOptional

Comma separated response status codes

Example: 401,403

weighted_feedback_minnumber · min: -10 · max: 10Optional

Minimum weighted feedback score

weighted_feedback_maxnumber · min: -10 · max: 10Optional

Maximum weighted feedback score

virtual_keysstringOptional

Comma separated virtual key slugs

Example: vk-slug-1,vk-slug-2

configsstringOptional

Comma separated config slugs

Example: pc-config-slug-1,pc-config-slug-2

workspace_slugstringOptional

Workspace slug filter. If a workspace API key is being used, this filter will not be taken into consideration. If an organisation API key is used and no workspace slug is passed, default workspace will be used.

api_key_idsstringOptional

Comma separated API key UUIDs

Example: 765768a9-b4ec-4694-962c-d55f40cdb0dc,7c22af5a-8119-46b8-8d9b-bad3ad382387

current_pageintegerOptional

Current page number

page_sizeintegerOptional

Number of items per page

metadatastringOptional

Stringifed json object with key value metadata pairs

Example: {"_user":"user_1", "env": "staging"}

ai_org_modelstringOptional

Comma separated ai provider and model combination. Double underscore (__) should be used as a separator for each provider and model combination

Example: openai__gpt-3.5-turbo,azure-openai__gpt-35-turbo

trace_idstringOptional

Comma separated trace IDs

Example: my-unique-trace-1,my-unique-trace-2

span_idstringOptional

Comma separated span IDs

Example: my-unique-span-1,my-unique-span-2

prompt_slugstringOptional

Comma separated prompt slugs

Example: prompt-slug-1,prompt-slug-2

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/analytics/groups/metadata/{metadataKey} HTTP/1.1
Host: api.portkey.ai
x-portkey-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "object": "list",
  "total": 1,
  "data": [
    {
      "metadata_value": "text",
      "requests": 1,
      "cost": 1,
      "avg_tokens": 1,
      "avg_weighted_feedback": 1,
      "requests_with_feedback": 1,
      "last_seen": "2025-06-09T07:53:20.798Z",
      "object": "analytics-group"
    }
  ]
}