Instale a nossa aplicação 🪄 clique no ícone no canto superior direito da barra de endereços.

Anotações

Recuperar tudo

GET https://metriva.com.br/api/annotations/
curl --request GET \
--url 'https://metriva.com.br/api/annotations/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
website_id Opcional Inteiro
search Opcional String A cadeia de pesquisa.
search_by Opcional String Por qual campo você está pesquisando. Os valores permitidos são: name.
datetime_field Opcional String Valores permitidos: datetime, last_datetime, chart_datetime
datetime_start Opcional String Filtrar resultados a partir desta data e hora. Formato Y-m-d H:i:s.
datetime_end Opcional String Filtrar resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional String Por que campo ordenar os resultados. Os valores permitidos são: annotation_id, website_id, datetime, last_datetime, name, chart_datetime.
order_type Opcional String A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente, e DESC para ordenação descendente.
page Opcional Inteiro O número da página da qual pretende obter resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você quer por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "website_id: 1,
            "user_id: 1,
            "name": "Example",
            "chart_datetime": "2026-07-14 03:11:38",
            "datetime": "2026-07-14 03:11:38",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://metriva.com.br/api/annotations?page=1",
        "last": "https://metriva.com.br/api/annotations?page=1",
        "next": null,
        "prev": null,
        "self": "https://metriva.com.br/api/annotations?page=1"
    }
}

Recuperar um

GET https://metriva.com.br/api/annotations/{annotation_id}
curl --request GET \
--url 'https://metriva.com.br/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "website_id: 1,
        "user_id: 1,
        "name": "Example",
        "chart_datetime": "2026-07-14 03:11:38",
        "datetime": "2026-07-14 03:11:38",
        "last_datetime": null
    }
}

Criar

POST https://metriva.com.br/api/annotations
Parâmetros Detalhes Descrição
website_id Obrigatório Inteiro -
name Obrigatório String -
chart_datetime Obrigatório String Y-m-d H:i:s
curl --request POST \
--url 'https://metriva.com.br/api/annotations' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'chart_datetime=2026-07-14 03:11:38' \
{
    "data": {
        "id": 1
    }
}

Atualizar

POST https://metriva.com.br/api/annotations/{annotation_id}
Parâmetros Detalhes Descrição
website_id Opcional Inteiro -
name Opcional String -
chart_datetime Opcional String Y-m-d H:i:s
curl --request POST \
--url 'https://metriva.com.br/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{
    "data": {
        "id": 1
    }
}

Eliminar

DELETE https://metriva.com.br/api/annotations/{annotation_id}
curl --request DELETE \
--url 'https://metriva.com.br/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \