Установите наше приложение 🪄 Нажмите на значок в правом верхнем углу адресной строки.

Аннотации

Получить все

GET https://analyticse.com/api/annotations/
curl --request GET \
--url 'https://analyticse.com/api/annotations/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Детали Описание
website_id Необязательный Целое число
search Необязательный Строка Строка поиска.
search_by Необязательный Строка По какому полю вы ищете? Разрешенные значения: name.
datetime_field Необязательный Строка Разрешенные значения: datetime, last_datetime, chart_datetime
datetime_start Необязательный Строка Дата начала
datetime_end Необязательный Строка Дата окончания
order_by Необязательный Строка По какому полю отсортировать результаты. Разрешенные значения: annotation_id, website_id, datetime, last_datetime, name, chart_datetime.
order_type Необязательный Строка Порядок результатов. Разрешенные значения: ASC для восходящего порядка и DESC для нисходящего порядка.
page Необязательный Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию 1.
results_per_page Необязательный Целое число Сколько результатов вы хотите на странице. Допустимые значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию 25. 
{
    "data": [
        {
            "id": 1,
            "website_id": 1,
            "user_id": 1,
            "name": "Example",
            "chart_datetime": "2026-09-12 00:42:20",
            "last_datetime": null,
            "datetime": "2026-09-12 00:42:20"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://analyticse.com/api/annotations?page=1",
        "last": "https://analyticse.com/api/annotations?page=1",
        "next": null,
        "prev": null,
        "self": "https://analyticse.com/api/annotations?page=1"
    }
}

Получить один

GET https://analyticse.com/api/annotations/{annotation_id}
curl --request GET \
--url 'https://analyticse.com/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "name": "Example",
        "chart_datetime": "2026-09-12 00:42:20",
        "last_datetime": null,
        "datetime": "2026-09-12 00:42:20"
    }
}

Создать

POST https://analyticse.com/api/annotations
Параметры Детали Описание
website_id Обязательно Целое число -
name Обязательно Строка -
chart_datetime Обязательно Строка Y-m-d H:i:s
curl --request POST \
--url 'https://analyticse.com/api/annotations' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'website_id=1' \
--form 'name=Example' \
--form 'chart_datetime=2026-09-12 00:42:20' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "name": "Example",
        "chart_datetime": "2026-09-12 00:42:20",
        "last_datetime": null,
        "datetime": "2026-09-12 00:42:20"
    }
}

Обновить

POST https://analyticse.com/api/annotations/{annotation_id}
Параметры Детали Описание
website_id Необязательный Целое число -
name Необязательный Строка -
chart_datetime Необязательный Строка Y-m-d H:i:s
curl --request POST \
--url 'https://analyticse.com/api/annotations/{annotation_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "name": "Example",
        "chart_datetime": "2026-09-12 00:42:20",
        "last_datetime": "2026-09-12 00:42:20",
        "datetime": "2026-09-12 00:42:20"
    }
}

Удалить

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