{ "opencollection": "1.0.0", "info": { "name": "Portkey Analytics > Graphs Analytics > Groups API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "x-portkey-api-key", "value": "{{x-portkey-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Analytics > Groups", "type": "folder" }, "items": [ { "info": { "name": "Get metadata users grouped data.", "type": "http" }, "http": { "method": "GET", "url": "https://api.portkey.ai/v1/analytics/groups/users", "params": [ { "name": "workspace_slug", "value": "", "type": "query", "description": "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." }, { "name": "time_of_generation_min", "value": "", "type": "query", "description": "Minimum time of generation in ISO8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)." }, { "name": "time_of_generation_max", "value": "", "type": "query", "description": "Maximum time of generation in ISO8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)." }, { "name": "total_units_min", "value": "", "type": "query", "description": "Minimum total units (tokens)" }, { "name": "total_units_max", "value": "", "type": "query", "description": "Maximum total units (tokens)" }, { "name": "cost_min", "value": "", "type": "query", "description": "Minimum cost (in cents)" }, { "name": "cost_max", "value": "", "type": "query", "description": "Maximum cost (in cents)" }, { "name": "prompt_token_min", "value": "", "type": "query", "description": "Minimum number of prompt tokens" }, { "name": "prompt_token_max", "value": "", "type": "query", "description": "Maximum number of prompt tokens" }, { "name": "completion_token_min", "value": "", "type": "query", "description": "Minimum number of completion tokens" }, { "name": "completion_token_max", "value": "", "type": "query", "description": "Maximum number of completion tokens" }, { "name": "status_code", "value": "401,403", "type": "query", "description": "Comma separated response status codes" }, { "name": "weighted_feedback_min", "value": "", "type": "query", "description": "Minimum weighted feedback score" }, { "name": "weighted_feedback_max", "value": "", "type": "query", "description": "Maximum weighted feedback score" }, { "name": "virtual_keys", "value": "vk-slug-1,vk-slug-2", "type": "query", "description": "Comma separated virtual key slugs" }, { "name": "configs", "value": "pc-config-slug-1,pc-config-slug-2", "type": "query", "description": "Comma separated config slugs" }, { "name": "api_key_ids", "value": "765768a9-b4ec-4694-962c-d55f40cdb0dc,7c22af5a-8119-46b8-8d9b-bad3ad382387", "type": "query", "description": "Comma separated API key UUIDs" }, { "name": "current_page", "value": "", "type": "query", "description": "Current page number" }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "metadata", "value": "{\"_user\":\"user_1\", \"env\": \"staging\"}", "type": "query", "description": "Stringifed json object with key value metadata pairs" }, { "name": "ai_org_model", "value": "openai__gpt-3.5-turbo,azure-openai__gpt-35-turbo", "type": "query", "description": "Comma separated ai provider and model combination. Double underscore (__) should be used as a separator for each provider and model combination" }, { "name": "trace_id", "value": "my-unique-trace-1,my-unique-trace-2", "type": "query", "description": "Comma separated trace IDs" }, { "name": "span_id", "value": "my-unique-span-1,my-unique-span-2", "type": "query", "description": "Comma separated span IDs" }, { "name": "prompt_slug", "value": "prompt-slug-1,prompt-slug-2", "type": "query", "description": "Comma separated prompt slugs" } ] }, "docs": "Get metadata users grouped data." }, { "info": { "name": "Get ai model grouped data.", "type": "http" }, "http": { "method": "GET", "url": "https://api.portkey.ai/v1/analytics/groups/ai-models", "params": [ { "name": "workspace_slug", "value": "", "type": "query", "description": "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." }, { "name": "time_of_generation_min", "value": "", "type": "query", "description": "Minimum time of generation in ISO8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)." }, { "name": "time_of_generation_max", "value": "", "type": "query", "description": "Maximum time of generation in ISO8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)." }, { "name": "total_units_min", "value": "", "type": "query", "description": "Minimum total units (tokens)" }, { "name": "total_units_max", "value": "", "type": "query", "description": "Maximum total units (tokens)" }, { "name": "cost_min", "value": "", "type": "query", "description": "Minimum cost (in cents)" }, { "name": "cost_max", "value": "", "type": "query", "description": "Maximum cost (in cents)" }, { "name": "prompt_token_min", "value": "", "type": "query", "description": "Minimum number of prompt tokens" }, { "name": "prompt_token_max", "value": "", "type": "query", "description": "Maximum number of prompt tokens" }, { "name": "completion_token_min", "value": "", "type": "query", "description": "Minimum number of completion tokens" }, { "name": "completion_token_max", "value": "", "type": "query", "description": "Maximum number of completion tokens" }, { "name": "status_code", "value": "401,403", "type": "query", "description": "Comma separated response status codes" }, { "name": "weighted_feedback_min", "value": "", "type": "query", "description": "Minimum weighted feedback score" }, { "name": "weighted_feedback_max", "value": "", "type": "query", "description": "Maximum weighted feedback score" }, { "name": "virtual_keys", "value": "vk-slug-1,vk-slug-2", "type": "query", "description": "Comma separated virtual key slugs" }, { "name": "configs", "value": "pc-config-slug-1,pc-config-slug-2", "type": "query", "description": "Comma separated config slugs" }, { "name": "api_key_ids", "value": "765768a9-b4ec-4694-962c-d55f40cdb0dc,7c22af5a-8119-46b8-8d9b-bad3ad382387", "type": "query", "description": "Comma separated API key UUIDs" }, { "name": "current_page", "value": "", "type": "query", "description": "Current page number" }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "metadata", "value": "{\"_user\":\"user_1\", \"env\": \"staging\"}", "type": "query", "description": "Stringifed json object with key value metadata pairs" }, { "name": "ai_org_model", "value": "openai__gpt-3.5-turbo,azure-openai__gpt-35-turbo", "type": "query", "description": "Comma separated ai provider and model combination. Double underscore (__) should be used as a separator for each provider and model combination" }, { "name": "trace_id", "value": "my-unique-trace-1,my-unique-trace-2", "type": "query", "description": "Comma separated trace IDs" }, { "name": "span_id", "value": "my-unique-span-1,my-unique-span-2", "type": "query", "description": "Comma separated span IDs" }, { "name": "prompt_slug", "value": "prompt-slug-1,prompt-slug-2", "type": "query", "description": "Comma separated prompt slugs" } ] }, "docs": "Get ai model grouped data." }, { "info": { "name": "Get metadata key based grouped data.", "type": "http" }, "http": { "method": "GET", "url": "https://api.portkey.ai/v1/analytics/groups/metadata/:metadataKey", "params": [ { "name": "metadataKey", "value": "", "type": "path" }, { "name": "workspace_slug", "value": "", "type": "query", "description": "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." }, { "name": "time_of_generation_min", "value": "", "type": "query", "description": "Minimum time of generation in ISO8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)." }, { "name": "time_of_generation_max", "value": "", "type": "query", "description": "Maximum time of generation in ISO8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)." }, { "name": "total_units_min", "value": "", "type": "query", "description": "Minimum total units (tokens)" }, { "name": "total_units_max", "value": "", "type": "query", "description": "Maximum total units (tokens)" }, { "name": "cost_min", "value": "", "type": "query", "description": "Minimum cost (in cents)" }, { "name": "cost_max", "value": "", "type": "query", "description": "Maximum cost (in cents)" }, { "name": "prompt_token_min", "value": "", "type": "query", "description": "Minimum number of prompt tokens" }, { "name": "prompt_token_max", "value": "", "type": "query", "description": "Maximum number of prompt tokens" }, { "name": "completion_token_min", "value": "", "type": "query", "description": "Minimum number of completion tokens" }, { "name": "completion_token_max", "value": "", "type": "query", "description": "Maximum number of completion tokens" }, { "name": "status_code", "value": "401,403", "type": "query", "description": "Comma separated response status codes" }, { "name": "weighted_feedback_min", "value": "", "type": "query", "description": "Minimum weighted feedback score" }, { "name": "weighted_feedback_max", "value": "", "type": "query", "description": "Maximum weighted feedback score" }, { "name": "virtual_keys", "value": "vk-slug-1,vk-slug-2", "type": "query", "description": "Comma separated virtual key slugs" }, { "name": "configs", "value": "pc-config-slug-1,pc-config-slug-2", "type": "query", "description": "Comma separated config slugs" }, { "name": "api_key_ids", "value": "765768a9-b4ec-4694-962c-d55f40cdb0dc,7c22af5a-8119-46b8-8d9b-bad3ad382387", "type": "query", "description": "Comma separated API key UUIDs" }, { "name": "current_page", "value": "", "type": "query", "description": "Current page number" }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "metadata", "value": "{\"_user\":\"user_1\", \"env\": \"staging\"}", "type": "query", "description": "Stringifed json object with key value metadata pairs" }, { "name": "ai_org_model", "value": "openai__gpt-3.5-turbo,azure-openai__gpt-35-turbo", "type": "query", "description": "Comma separated ai provider and model combination. Double underscore (__) should be used as a separator for each provider and model combination" }, { "name": "trace_id", "value": "my-unique-trace-1,my-unique-trace-2", "type": "query", "description": "Comma separated trace IDs" }, { "name": "span_id", "value": "my-unique-span-1,my-unique-span-2", "type": "query", "description": "Comma separated span IDs" }, { "name": "prompt_slug", "value": "prompt-slug-1,prompt-slug-2", "type": "query", "description": "Comma separated prompt slugs" } ] }, "docs": "Get metadata key based grouped data." } ] } ], "bundled": true }