Цели

Получить все

GET https://analytics.readl.ru/api/goals/
curl --request GET \
--url 'https://analytics.readl.ru/api/goals/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Подробнее Описание
website_id Необязательно Целое число
type Необязательно Строка Допустимые значения: pageview, custom, scroll
search Необязательно Строка Строка поиска.
search_by Необязательно Строка Поле для поиска. Допустимые значения: name, path, key.
datetime_field Необязательно Строка Допустимые значения: datetime, last_datetime
datetime_start Необязательно Строка Начальные дата и время для фильтра. Формат Y-m-d H:i:s.
datetime_end Необязательно Строка Конечные дата и время для фильтра. Формат Y-m-d H:i:s.
order_by Необязательно Строка Поле для сортировки результатов. Допустимые значения: goal_id, last_datetime, datetime, name, path, key, scroll_percentage.
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,
            "key": "123456789",
            "type": "custom",
            "path": null,
            "scroll_percentage": null,
            "name": "Example",
            "last_datetime": null,
            "datetime": "2026-10-13 13:55:00"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://analytics.readl.ru/api/goals?page=1",
        "last": "https://analytics.readl.ru/api/goals?page=1",
        "next": null,
        "prev": null,
        "self": "https://analytics.readl.ru/api/goals?page=1"
    }
}

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

GET https://analytics.readl.ru/api/goals/{goal_id}
curl --request GET \
--url 'https://analytics.readl.ru/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "custom",
        "path": null,
        "scroll_percentage": null,
        "name": "Example",
        "last_datetime": null,
        "datetime": "2026-10-13 13:55:00"
    }
}

Создать

POST https://analytics.readl.ru/api/goals
Параметры Подробнее Описание
website_id Обязательно Целое число -
type Обязательно Строка Допустимые значения: pageview, custom, scroll
name Обязательно Строка -
path Необязательно Строка Доступно при: type = pageview, scroll
scroll_percentage Необязательно Целое число Доступно при: type = scroll
key Необязательно Строка -
curl --request POST \
--url 'https://analytics.readl.ru/api/goals' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'website_id=1' \
--form 'name=Example' \
--form 'type=scroll' \
--form 'path=blog/*' \
--form 'scroll_percentage=75' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "scroll",
        "path": "/blog/*",
        "scroll_percentage": 75,
        "name": "Example",
        "last_datetime": null,
        "datetime": "2026-10-13 13:55:00"
    }
}

Обновить

POST https://analytics.readl.ru/api/goals/{goal_id}
Параметры Подробнее Описание
website_id Необязательно Целое число -
type Необязательно Строка Допустимые значения: pageview, custom, scroll
name Необязательно Строка -
path Необязательно Строка Доступно при: type = pageview, scroll
scroll_percentage Необязательно Целое число Доступно при: type = scroll
key Необязательно Строка -
curl --request POST \
--url 'https://analytics.readl.ru/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=scroll' \
--form 'path=blog/*' \
--form 'scroll_percentage=75' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "scroll",
        "path": "/blog/*",
        "scroll_percentage": 75,
        "name": "Example",
        "last_datetime": "2026-10-13 13:55:00",
        "datetime": "2026-10-13 13:55:00"
    }
}

Удалить

DELETE https://analytics.readl.ru/api/goals/{goal_id}
curl --request DELETE \
--url 'https://analytics.readl.ru/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \