---
updatedAt: 2026-08-10T11:35:06.000Z
agentTools:
  projectIndex: https://docs.tryatria.com/llms.txt
---

# List ad-account metrics

List every metric defined on this ad account — Atria's built-in metrics plus everything configured per-account: Meta custom conversions (`fb_cc_*`), Meta custom events (`fb_ce_*`), and Atria custom metrics (user-defined formulas). All of them are returned by default.

This is a **definition catalog, not values** — it tells you which metrics exist on the account and what to call them. Ids returned here are the canonical, stable way to name a metric; display names are user-editable and can collide, so prefer `id`.

The custom entries are account-specific and change whenever they are edited in Meta or in Atria, so re-read the catalog rather than hardcoding ids. Meta custom conversions / events exist on Facebook accounts only.

Scoped to the workspace bound to your API key. Filter with `kind` to fetch one family at a time — accounts can define hundreds of custom conversions.

Returns: `code=0` success; `code=40001` invalid `account_id` or workspace context missing; `code=40401` when the account does not exist or belongs to a different workspace.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Atria Open API",
    "version": "1.0.0",
    "description": "Public API for the Atria platform."
  },
  "paths": {
    "/open/v1/ad-accounts/{account_id}/metrics": {
      "get": {
        "tags": [
          "Ad Accounts"
        ],
        "summary": "List ad-account metrics",
        "description": "List every metric defined on this ad account — Atria's built-in metrics plus everything configured per-account: Meta custom conversions (`fb_cc_*`), Meta custom events (`fb_ce_*`), and Atria custom metrics (user-defined formulas). All of them are returned by default.\n\nThis is a **definition catalog, not values** — it tells you which metrics exist on the account and what to call them. Ids returned here are the canonical, stable way to name a metric; display names are user-editable and can collide, so prefer `id`.\n\nThe custom entries are account-specific and change whenever they are edited in Meta or in Atria, so re-read the catalog rather than hardcoding ids. Meta custom conversions / events exist on Facebook accounts only.\n\nScoped to the workspace bound to your API key. Filter with `kind` to fetch one family at a time — accounts can define hundreds of custom conversions.\n\nReturns: `code=0` success; `code=40001` invalid `account_id` or workspace context missing; `code=40401` when the account does not exist or belongs to a different workspace.",
        "operationId": "list_ad_account_metrics",
        "parameters": [
          {
            "description": "Internal Atria ad-account id (UUID; dashed or 32-char hex both parse). Obtain it from `GET /ad-accounts` (`items[].id`).",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Account Id",
              "description": "Internal Atria ad-account id (UUID; dashed or 32-char hex both parse). Obtain it from `GET /ad-accounts` (`items[].id`)."
            },
            "name": "account_id",
            "in": "path"
          },
          {
            "description": "Return only this family of metrics. **Omit to get all of them** (the default). `standard` is Atria's built-in set; `facebook_custom_conversion` / `facebook_custom_event` are configured by the advertiser in Meta; `atria_custom_metric` are user-defined formulas in Atria.",
            "required": false,
            "schema": {
              "allOf": [
                {
                  "type": "string",
                  "enum": [
                    "standard",
                    "facebook_custom_conversion",
                    "facebook_custom_event",
                    "atria_custom_metric"
                  ],
                  "title": "OpenMetricKind",
                  "description": "Where a metric definition comes from.\n\n`standard` is Atria's built-in metric set (same for every account of\nthat platform). The other three are configured per ad account — the\nfirst two in Meta, the third in Atria — so the catalog differs\naccount to account."
                }
              ],
              "description": "Return only this family of metrics. **Omit to get all of them** (the default). `standard` is Atria's built-in set; `facebook_custom_conversion` / `facebook_custom_event` are configured by the advertiser in Meta; `atria_custom_metric` are user-defined formulas in Atria."
            },
            "name": "kind",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response Input validation also returns HTTP 200 with code=40001 and message.",
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/SuccessResponse_OpenAdAccountMetricListData_"
                    },
                    {
                      "$ref": "#/components/schemas/ErrorResponse"
                    }
                  ],
                  "title": "Response List Ad Account Metrics"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "code": 40100,
                  "message": "Authentication failed"
                }
              }
            }
          },
          "429": {
            "description": "rate limit or quota exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "code": 42900,
                  "message": "rate limit or quota exceeded"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "properties": {
          "code": {
            "not": {
              "enum": [
                0
              ]
            },
            "type": "integer",
            "title": "Code"
          },
          "message": {
            "type": "string",
            "title": "Message"
          },
          "data": {
            "type": "null",
            "title": "Data"
          }
        },
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "title": "ErrorResponse"
      },
      "OpenAdAccountMetric": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "Stable metric identifier. Built-in metrics use a readable slug (`spend`, `ctr_all`); Meta custom conversions / events use `fb_cc_*__<conversion_id>` / `fb_ce_*__<event_id>`; Atria custom metrics use their UUID. Prefer this over `name` when referring to a metric — display names are user-editable and can collide."
          },
          "name": {
            "type": "string",
            "title": "Name",
            "description": "Human-readable display name."
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description",
            "description": "Definition text, where the metric carries one."
          },
          "kind": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OpenMetricKind"
              }
            ],
            "description": "Origin of the metric definition."
          },
          "data_type": {
            "type": "string",
            "title": "Data Type",
            "description": "Value type of the metric, e.g. `INTEGER`, `FLOAT`, `STRING`."
          },
          "is_currency": {
            "type": "boolean",
            "title": "Is Currency",
            "description": "Whether values are monetary, denominated in the ad account's `currency` (see `GET /ad-accounts`).",
            "default": false
          },
          "is_inverse": {
            "type": "boolean",
            "title": "Is Inverse",
            "description": "Whether a lower value is better — cost metrics like CPA and CPC. Endpoints that rank on a metric flip their default sort direction for these, so the best rows still come first.",
            "default": false
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "kind",
          "data_type"
        ],
        "title": "OpenAdAccountMetric"
      },
      "OpenAdAccountMetricListData": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/OpenAdAccountMetric"
            },
            "type": "array",
            "title": "Items"
          },
          "total": {
            "type": "integer",
            "title": "Total",
            "description": "Number of metrics returned (after any `kind` filter).",
            "default": 0
          }
        },
        "type": "object",
        "title": "OpenAdAccountMetricListData"
      },
      "OpenMetricKind": {
        "type": "string",
        "enum": [
          "standard",
          "facebook_custom_conversion",
          "facebook_custom_event",
          "atria_custom_metric"
        ],
        "title": "OpenMetricKind",
        "description": "Where a metric definition comes from.\n\n`standard` is Atria's built-in metric set (same for every account of\nthat platform). The other three are configured per ad account — the\nfirst two in Meta, the third in Atria — so the catalog differs\naccount to account."
      },
      "SuccessResponse_OpenAdAccountMetricListData_": {
        "properties": {
          "code": {
            "type": "integer",
            "enum": [
              0
            ],
            "title": "Code",
            "default": 0
          },
          "message": {
            "type": "string",
            "title": "Message",
            "default": "ok"
          },
          "data": {
            "$ref": "#/components/schemas/OpenAdAccountMetricListData"
          }
        },
        "type": "object",
        "required": [
          "data"
        ],
        "title": "SuccessResponse[OpenAdAccountMetricListData]"
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "servers": [
    {
      "url": "https://api.tryatria.com",
      "description": "Production"
    }
  ],
  "tags": [
    {
      "name": "Ad Accounts",
      "description": "Performance data and video transcripts for Facebook / TikTok ad accounts linked to the workspace."
    }
  ]
}
```