> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# Get metrics SQL schema

> Get metrics SQL schema: getMessageMetricsSqlSchema in the TypeScript, Python and Rust clients.

`GET /v1/projects/{projectId}/metrics/query`

Returns the message\_events and call\_events SQL schema, supported queries, and limits for the selected API version.

<Tabs>
  <Tab title="TypeScript">
    ```typescript TypeScript theme={null}
    photon.projects.getMessageMetricsSqlSchema(input: GetMessageMetricsSqlSchemaInput, options?: RequestOptions): Promise<GetMessageMetricsSqlSchemaOutput>
    ```
  </Tab>

  <Tab title="Python">
    ```python Python theme={null}
    photon.projects.get_message_metrics_sql_schema(input: GetMessageMetricsSqlSchemaInput) -> models.GetMessageMetricsSqlSchemaResponse
    ```
  </Tab>

  <Tab title="Rust">
    ```rust Rust theme={null}
    client.get_message_metrics_sql_schema(project_id: String, params: Option<GetMessageMetricsSqlSchemaParams>).await -> Result<ResponseValue<types::GetMessageMetricsSqlSchemaResponse>, Error<GetMessageMetricsSqlSchemaError>>
    ```
  </Tab>
</Tabs>

<RequestExample>
  ```typescript TypeScript theme={null}
  import { Photon } from "@photon-ai/api";

  const photon = new Photon({
    headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
  });
  const result = await photon.projects.getMessageMetricsSqlSchema({
    path: {
      projectId: "projectId",
    },
  });
  ```

  ```python Python theme={null}
  import os

  from photon_api import Photon
  from photon_api.rpc_generated import GetMessageMetricsSqlSchemaInput

  photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
  result = photon.projects.get_message_metrics_sql_schema(
      GetMessageMetricsSqlSchemaInput.model_validate({
          "path": {
              "projectId": "projectId",
          },
      })
  )
  ```

  ```rust Rust theme={null}
  use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

  let token = std::env::var("PHOTON_API_TOKEN")?;
  let client = PhotonClientBuilder::new()
      .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
      .build()?;
  let result = client
      .get_message_metrics_sql_schema("projectId".to_owned(), None)
      .await
      .map_err(|error| format!("{error:?}"))?
      .into_inner();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "capabilities": {
      "arrayJoin": true,
      "ctes": true,
      "joins": true,
      "parameters": true,
      "selectWithoutFrom": true,
      "subqueries": true,
      "unions": true
    },
    "dialect": "string",
    "limits": {
      "maximumParameterValueBytes": 1,
      "maximumParameters": 1,
      "maximumSqlBytes": 1,
      "maximumTotalParameterBytes": 1
    },
    "projectScoped": true,
    "tables": [
      {
        "columns": [
          {
            "description": "string",
            "json": {},
            "name": "string",
            "type": "string"
          }
        ],
        "currentState": "string",
        "description": "string",
        "name": "message_events"
      }
    ],
    "version": "2026-01-01"
  }
  ```
</ResponseExample>

## Parameters

<ParamField path="projectId" type={"string"} required />

<ParamField header="x-photon-version" type={"string (date)"}>
  API schema date. Defaults to the latest served version; resolves to the latest served date on or before this value.
</ParamField>

## Returns

**`200`** The Project-scoped SQL surface of the resolved contracts date. GetMessageMetricsSqlSchemaResponse

<ResponseField name="capabilities" type={"MessageMetricsSqlCapabilities"} required />

<ResponseField name="dialect" type={"string"} required />

<ResponseField name="limits" type={"MessageMetricsSqlLimits"} required />

<ResponseField name="projectScoped" type={"true"} required />

<ResponseField name="tables" type={"array of MessageMetricsSqlTable"} required />

<ResponseField name="version" type={"string (date)"} required />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.