> ## Documentation Index > Fetch the complete documentation index at: https://docs.roark.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the analytics schema > Lists what can go into an analytics query for this project: every metric by slug with its output type, default aggregation and the aggregations it supports; the measure types; the filter and breakdown types with the properties each accepts; and the custom call properties seen in the project. Read this first when building a query. ## OpenAPI ````yaml /api-reference/openapi.documented.json get /v1/analytics/schema openapi: 3.1.0 info: title: Roark Analytics API description: >- The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform. version: 1.0.0 servers: - description: Production url: https://api.roark.ai security: - Bearer: [] tags: - name: Agent - name: Agent Endpoint - name: Call - name: Chat - name: Metric - name: Metric Policy - name: Metric Collection Job - name: Customer Flow - name: Customer Flow Edge Case - name: Simulation - name: Simulation Persona - name: Simulation Environment - name: Simulation Scenario - name: Simulation Run Plan - name: Simulation Template - name: Simulation Run Plan Job - name: Simulation Job - name: HTTP Request Definition - name: Webhook - name: Issue - name: Autoimprove - name: Agent Config - name: Knowledge Base - name: Config - name: Organization Project - name: Organization Project Member - name: Organization Project API Key - name: Organization Config - name: CLI Auth - name: Me - name: Project - name: Usage - name: Analytics - name: Dashboard - name: Benchmark - name: Health - name: Prospect Simulation paths: /v1/analytics/schema: get: tags: - Analytics summary: Get the analytics schema description: >- Lists what can go into an analytics query for this project: every metric by slug with its output type, default aggregation and the aggregations it supports; the measure types; the filter and breakdown types with the properties each accepts; and the custom call properties seen in the project. Read this first when building a query. operationId: getV1AnalyticsSchema responses: '200': description: The analytics schema content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AnalyticsSchema' required: - data '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication error example: type: authentication code: unauthorized message: Authentication required description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Permission error example: type: forbidden code: permission_denied message: You do not have permission to access this resource description: Forbidden '429': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit error example: type: rate_limit code: too_many_requests message: Rate limit exceeded description: Too Many Requests '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Server error example: type: internal code: internal_error message: Internal server error description: Internal Server Error x-codeSamples: - lang: JavaScript source: |- import Roark from '@roarkanalytics/sdk'; const client = new Roark({ bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted }); const response = await client.analytics.getSchema(); console.log(response.data); - lang: Python source: |- import os from roark_analytics import Roark client = Roark( bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted ) response = client.analytics.get_schema() print(response.data) components: schemas: AnalyticsSchema: type: object properties: metrics: type: array items: type: object properties: id: type: string format: uuid slug: type: string name: type: string outputType: type: string isThreshold: type: boolean defaultAggregation: type: string enum: - COUNT - AVG - MIN - MAX - SUM - MEDIAN - PERCENTILE - PASS_RATE aggregations: type: array items: type: string enum: - COUNT - AVG - MIN - MAX - SUM - MEDIAN - PERCENTILE - PASS_RATE required: - id - slug - name - outputType - isThreshold - defaultAggregation - aggregations measureTypes: type: array items: type: object properties: type: type: string enum: - METRIC - CONVERSATION - UPTIME description: type: string aggregations: type: array items: type: string enum: - COUNT - AVG - MIN - MAX - SUM - MEDIAN - PERCENTILE - PASS_RATE required: - type - description - aggregations filters: type: array items: type: object properties: type: type: string enum: - METRIC_PROPERTY - CALL_PROPERTY - AGENT_PROPERTY - CALL_ID - MODALITY - DATASET - METRIC_VALUE description: type: string properties: type: array items: type: object properties: property: type: string description: type: string required: - property - description required: - type - description - properties breakdowns: type: array items: type: object properties: type: type: string enum: - METRIC_PROPERTY - CALL_PROPERTY - AGENT_PROPERTY - DATASET description: type: string required: - type - description callProperties: type: array items: type: object properties: name: type: string valueType: type: string isSystem: type: boolean required: - name - valueType - isSystem operators: type: array items: type: string enum: - EQUALS - NOT_EQUALS - GREATER_THAN - GREATER_THAN_OR_EQUAL_TO - LESS_THAN - LESS_THAN_OR_EQUAL_TO - CONTAINS - STARTS_WITH intervals: type: array items: type: string enum: - HOUR - DAY - WEEK - MONTH displayTypes: type: array items: type: string enum: - LINE - NUMBER - RADAR - STACKED_BAR - TABLE required: - metrics - measureTypes - filters - breakdowns - callProperties - operators - intervals - displayTypes description: >- What can be queried in this project: metrics (by slug), measure types, filters, breakdowns. ErrorResponse: type: object properties: type: type: string enum: - validation - authentication - forbidden - not_found - conflict - payment_required - rate_limit - internal description: The error type category examples: - validation - authentication code: type: string description: Machine-readable error code identifier examples: - invalid_parameter - missing_required_field - unauthorized message: type: string description: Human-readable error message examples: - The request was invalid - Authentication required param: type: string description: The parameter that caused the error (if applicable) examples: - email - user_id details: description: Additional error context information required: - type - code - message securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.