Annotations

Recuperar tudo

GET https://mapadecalor.com.br/api/annotations/
curl --request GET \
--url 'https://mapadecalor.com.br/api/annotations/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
website_id Opcional inteiro
search Opcional Corda A cadeia de pesquisa.
search_by Opcional Corda Por qual campo você está pesquisando. Os valores permitidos são: name.
datetime_field Opcional Corda Valores permitidos: datetime, last_datetime, chart_datetime
datetime_start Opcional Corda Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opcional Corda Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opcional Corda Por qual campo ordenar os resultados. Os valores permitidos são: annotation_id, website_id, datetime, last_datetime, name, chart_datetime.
order_type Opcional Corda A ordenação dos resultados. Os valores permitidos são: ASC para ordem crescente e DESC para ordem decrescente.
page Opcional inteiro O número da página da qual você deseja resultados. O padrão é 1.
results_per_page Opcional inteiro Quantos resultados você deseja 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-09-21 07:33:27",
            "datetime": "2026-09-21 07:33:27",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://mapadecalor.com.br/api/annotations?page=1",
        "last": "https://mapadecalor.com.br/api/annotations?page=1",
        "next": null,
        "prev": null,
        "self": "https://mapadecalor.com.br/api/annotations?page=1"
    }
}

Recupere um

GET https://mapadecalor.com.br/api/annotations/{annotation_id}
curl --request GET \
--url 'https://mapadecalor.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-09-21 07:33:27",
        "datetime": "2026-09-21 07:33:27",
        "last_datetime": null
    }
}

Criar

POST https://mapadecalor.com.br/api/annotations
Parâmetros Detalhes Descrição
website_id Obrigatório inteiro -
name Obrigatório Corda -
chart_datetime Obrigatório Corda Y-m-d H:i:s
curl --request POST \
--url 'https://mapadecalor.com.br/api/annotations' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'chart_datetime=2026-09-21 07:33:27' \
{
    "data": {
        "id": 1
    }
}

Atualizar

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

Excluir

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