> ## Documentation Index > Fetch the complete documentation index at: https://docs.levios.app/llms.txt > Use this file to discover all available pages before exploring further. # Consultar métricas da conta > Leia os KPIs da conta levios e as automações com melhor desempenho em uma janela de 7 ou 30 dias, prontos para renderizar em um painel. Este endpoint retorna os KPIs da conta e até cinco automações principais. Use o `id` de uma conta obtido em [Listar contas](/pt-BR/api/v1/accounts/list) como `account_id`. ## Acesso Sua chave de API precisa do escopo `metrics:read` e acesso à conta selecionada. ## Selecione um período Defina `window` com um destes valores de enum: * `7d`: o período dos últimos 7 dias. Este é o padrão. * `30d`: o período dos últimos 30 dias. Para `dms_sent` e `new_contacts`, `value` abrange o período selecionado, e `prev` abrange o período imediatamente anterior com a mesma duração. `delta_pct` é a variação percentual arredondada entre eles. O valor será `null` quando `prev` for zero. ## KPIs retornados O objeto `kpis` contém: | Campo | Significado | | - | - | | `dms_sent` | Mensagens diretas enviadas nos períodos selecionado e anterior, com a variação percentual. | | `new_contacts` | Contatos vistos pela primeira vez nos períodos selecionado e anterior, com a variação percentual. | | `leads` | `total` de contatos com e-mail ou telefone e capturas em `last_window` que podem ser datadas no período selecionado. | | `active_automations` | Contagens de automações ativas (`active`), `paused` e `total`. O total também pode incluir rascunhos. | `leads.last_window` pode ser `null` quando existem leads, mas os timestamps de captura não estão disponíveis. ## Principais automações `top_automations` contém no máximo cinco itens. Cada item inclui `id`, `name`, `status`, `dms_last_7d` e `last_fired_at`. O enum `status` tem estes valores: * `draft`: salva, mas não processa novos gatilhos. * `live`: ativa e capaz de processar gatilhos correspondentes. * `paused`: inativa até que seja ativada novamente. `dms_last_7d` sempre abrange os últimos sete dias, mesmo quando você solicita o período de conta `30d`. `last_fired_at` será `null` quando a automação ainda não tiver sido acionada. ## Exemplo de requisição ```bash theme={null} curl --get \ --url 'https://levios.app/api/v1/metrics' \ --header "Authorization: Bearer ${LEVIOS_API_KEY}" \ --data-urlencode "account_id=${LEVIOS_ACCOUNT_ID}" \ --data-urlencode 'window=30d' ``` ## OpenAPI ````yaml openapi/v1.json GET /api/v1/metrics openapi: 3.1.0 info: title: levios public API version: '1' servers: - url: https://levios.app security: - bearerAuth: [] paths: /api/v1/metrics: get: tags: - metric summary: Get account metrics description: Returns account KPIs and top automations for a 7-day or 30-day window. operationId: metrics.get parameters: - name: account_id in: query required: true schema: type: string format: uuid - name: window in: query required: false schema: description: >- Values: `30d`: the trailing 30-day period; `7d`: the trailing 7-day period. type: string enum: - 30d - 7d responses: '200': description: Successful response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: type: object properties: kpis: type: object properties: active_automations: type: object properties: active: type: integer minimum: 0 maximum: 9007199254740991 paused: type: integer minimum: 0 maximum: 9007199254740991 total: type: integer minimum: 0 maximum: 9007199254740991 required: - active - paused - total additionalProperties: false dms_sent: type: object properties: delta_pct: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' prev: type: integer minimum: 0 maximum: 9007199254740991 value: type: integer minimum: 0 maximum: 9007199254740991 required: - delta_pct - prev - value additionalProperties: false leads: type: object properties: last_window: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' total: type: integer minimum: 0 maximum: 9007199254740991 required: - last_window - total additionalProperties: false new_contacts: type: object properties: delta_pct: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' prev: type: integer minimum: 0 maximum: 9007199254740991 value: type: integer minimum: 0 maximum: 9007199254740991 required: - delta_pct - prev - value additionalProperties: false required: - active_automations - dms_sent - leads - new_contacts additionalProperties: false top_automations: type: array items: type: object properties: dms_last_7d: type: integer minimum: 0 maximum: 9007199254740991 id: type: string format: uuid last_fired_at: anyOf: - type: string pattern: >- ^(?!0000-)(?:(?:(?:[0-9]{2}(?:0[48]|[2468][048]|[13579][26])|(?:[02468][048]|[13579][26])00)-02-29)|(?:\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-8]))))T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,6})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$ minLength: 20 maxLength: 32 - type: 'null' name: type: string minLength: 1 maxLength: 120 status: description: >- Values: `draft`: saved but not processing new triggers; `live`: active and able to process matching triggers; `paused`: inactive until it is activated again. type: string enum: - draft - live - paused required: - dms_last_7d - id - last_fired_at - name - status additionalProperties: false maxItems: 5 window: description: >- Values: `30d`: the trailing 30-day period; `7d`: the trailing 7-day period. type: string enum: - 30d - 7d required: - kpis - top_automations - window additionalProperties: false '400': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: oneOf: - type: object properties: error: type: object properties: code: type: string enum: - api_invalid_content_length correlation_id: type: string message: type: string enum: - Invalid Content-Length. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_invalid_json correlation_id: type: string message: type: string enum: - The request body is not valid JSON. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_invalid_request_url correlation_id: type: string message: type: string enum: - The request URL is invalid. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_invalid_utf8 correlation_id: type: string message: type: string enum: - The request body is not valid UTF-8. required: - code - message additionalProperties: false required: - error additionalProperties: false '401': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ WWW-Authenticate: description: API key Bearer challenge. schema: type: string enum: - Bearer content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - api_unauthorized correlation_id: type: string message: type: string enum: - Authentication required. required: - code - message additionalProperties: false required: - error additionalProperties: false '403': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: oneOf: - type: object properties: error: type: object properties: code: type: string enum: - api_account_not_granted correlation_id: type: string message: type: string enum: - >- This credential is not authorized for the request. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_forbidden correlation_id: type: string message: type: string enum: - >- This credential is not authorized for the request. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_scope_denied correlation_id: type: string message: type: string enum: - >- This credential is not authorized for the request. required: - code - message additionalProperties: false required: - error additionalProperties: false '413': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: oneOf: - type: object properties: error: type: object properties: code: type: string enum: - api_body_too_large correlation_id: type: string message: type: string enum: - The JSON request body exceeds 1 MiB. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_json_too_deep correlation_id: type: string message: type: string enum: - The JSON request body exceeds maximum depth. required: - code - message additionalProperties: false required: - error additionalProperties: false '415': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - api_unsupported_media_type correlation_id: type: string message: type: string enum: - Content-Type must be application/json. required: - code - message additionalProperties: false required: - error additionalProperties: false '422': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - api_validation_error correlation_id: type: string details: type: object properties: issues: type: array items: type: object properties: code: type: string minLength: 1 maxLength: 64 path: type: array items: type: integer minimum: 0 maxItems: 16 required: - code - path additionalProperties: false maxItems: 32 required: - issues additionalProperties: false message: type: string enum: - The request does not match the declared schema. required: - code - message additionalProperties: false required: - error additionalProperties: false '429': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ Retry-After: description: Seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - rate_limited correlation_id: type: string message: type: string enum: - Rate limit exceeded. required: - code - message additionalProperties: false required: - error additionalProperties: false '500': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: oneOf: - type: object properties: error: type: object properties: code: type: string enum: - api_internal_error correlation_id: type: string message: type: string enum: - The request could not be completed. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_invalid_projection correlation_id: type: string message: type: string enum: - The metrics projection is invalid. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - api_projection_too_large correlation_id: type: string message: type: string enum: - >- The projected result exceeds the result byte limit. required: - code - message additionalProperties: false required: - error additionalProperties: false '503': description: Error response. headers: X-Correlation-ID: description: Correlation identifier for this request. schema: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ content: application/json: schema: oneOf: - type: object properties: error: type: object properties: code: type: string enum: - api_metrics_read_unavailable correlation_id: type: string message: type: string enum: - The account metrics could not be read. required: - code - message additionalProperties: false required: - error additionalProperties: false - type: object properties: error: type: object properties: code: type: string enum: - rate_limiter_unavailable correlation_id: type: string message: type: string enum: - Rate limiter unavailable. required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: Levios API key sent as a Bearer token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.