10% de remise sur les abonnements annuels

Annotations

Récupérer tous

GET https://analytics.sycow.fr/api/annotations/
curl --request GET \
--url 'https://analytics.sycow.fr/api/annotations/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
website_id Optionnel Entier
search Optionnel Chaîne La chaîne de recherche.
search_by Optionnel Chaîne Champ utilisé pour la recherche. Valeurs autorisées : name.
datetime_field Optionnel Chaîne Valeurs autorisées : datetime, last_datetime, chart_datetime
datetime_start Optionnel Chaîne Filtrer les résultats à partir de cette date/heure. Format Y-m-d H:i:s.
datetime_end Optionnel Chaîne Filtrer les résultats jusqu’à cette date/heure. Format Y-m-d H:i:s.
order_by Optionnel Chaîne Champ utilisé pour le tri des résultats. Valeurs autorisées : annotation_id, website_id, datetime, last_datetime, name, chart_datetime.
order_type Optionnel Chaîne Ordre des résultats. Valeurs autorisées : ASC pour croissant et DESC pour décroissant.
page Optionnel Entier Le numéro de page dont vous souhaitez récupérer les résultats. Valeur par défaut : 1.
results_per_page Optionnel Entier Nombre de résultats par page. Valeurs autorisées : 10, 25, 50, 100, 250, 500, 1000. Valeur par défaut : 25. 
{
    "data": [
        {
            "id": 1,
            "website_id: 1,
            "user_id: 1,
            "name": "Example",
            "chart_datetime": "2026-06-09 23:43:38",
            "datetime": "2026-06-09 23:43:38",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://analytics.sycow.fr/api/annotations?page=1",
        "last": "https://analytics.sycow.fr/api/annotations?page=1",
        "next": null,
        "prev": null,
        "self": "https://analytics.sycow.fr/api/annotations?page=1"
    }
}

Récupérer un

GET https://analytics.sycow.fr/api/annotations/{annotation_id}
curl --request GET \
--url 'https://analytics.sycow.fr/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "website_id: 1,
        "user_id: 1,
        "name": "Example",
        "chart_datetime": "2026-06-09 23:43:38",
        "datetime": "2026-06-09 23:43:38",
        "last_datetime": null
    }
}

Créer

POST https://analytics.sycow.fr/api/annotations
Paramètres Détails Description
website_id Obligatoire Entier -
name Obligatoire Chaîne -
chart_datetime Obligatoire Chaîne Y-m-d H:i:s
curl --request POST \
--url 'https://analytics.sycow.fr/api/annotations' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'chart_datetime=2026-06-09 23:43:38' \
{
    "data": {
        "id": 1
    }
}

Mettre à jour

POST https://analytics.sycow.fr/api/annotations/{annotation_id}
Paramètres Détails Description
website_id Optionnel Entier -
name Optionnel Chaîne -
chart_datetime Optionnel Chaîne Y-m-d H:i:s
curl --request POST \
--url 'https://analytics.sycow.fr/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{
    "data": {
        "id": 1
    }
}

Supprimer

DELETE https://analytics.sycow.fr/api/annotations/{annotation_id}
curl --request DELETE \
--url 'https://analytics.sycow.fr/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \