> ## 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.

# Obtener métricas de una cuenta

> Lee los KPIs de la cuenta levios y las automatizaciones con mejor desempeño en una ventana de 7 o 30 días, listos para un panel de control.

Este endpoint devuelve los KPIs de una cuenta y hasta cinco automatizaciones
principales. Usa un `id` de
[Listar cuentas](/es/api/v1/accounts/list) como `account_id`.

## Acceso

Tu clave de API necesita el permiso `metrics:read` y acceso a la cuenta
seleccionada.

## Selecciona un periodo

Configura `window` con uno de estos valores del enum:

* `7d`: el periodo de los últimos 7 días. Este es el valor predeterminado.
* `30d`: el periodo de los últimos 30 días.

Para `dms_sent` y `new_contacts`, `value` abarca el periodo seleccionado y
`prev` abarca el periodo inmediatamente anterior de la misma duración.
`delta_pct` es el cambio porcentual redondeado entre ambos. Es `null` cuando
`prev` es cero.

## KPIs devueltos

El objeto `kpis` contiene:

| Campo | Significado |
| - | - |
| `dms_sent` | Mensajes directos enviados en los periodos seleccionado y anterior, junto con su cambio porcentual. |
| `new_contacts` | Contactos detectados por primera vez en los periodos seleccionado y anterior, junto con su cambio porcentual. |
| `leads` | Contactos `total` con correo electrónico o teléfono y capturas `last_window` que se pueden fechar dentro del periodo seleccionado. |
| `active_automations` | Recuentos de automatizaciones activas (`active`), en pausa (`paused`) y totales (`total`). El total también puede incluir borradores. |

`leads.last_window` puede ser `null` cuando existen leads, pero sus marcas de
tiempo de captura no están disponibles.

## Automatizaciones principales

`top_automations` contiene como máximo cinco elementos. Cada uno incluye `id`,
`name`, `status`, `dms_last_7d` y `last_fired_at`.

El enum `status` tiene estos valores:

* `draft`: guardada, pero no procesa activadores nuevos.
* `live`: activa y capaz de procesar activadores que coincidan.
* `paused`: inactiva hasta que se vuelva a activar.

`dms_last_7d` siempre abarca los últimos siete días, incluso cuando solicitas
el periodo de cuenta `30d`. `last_fired_at` es `null` si la automatización no
se ha ejecutado.

## Solicitud de ejemplo

```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.