Выгрузка профилей в файл

Описание

Получить информацию о всех профилях подписчиков базы данных или ресурса.

Состоит из 3 запросов.

1 - выгрузка данных в файл

URL-адрес

Метод: POST

https://example.com/api/v1.1/profiles/get_all

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
source_type	string	"database" "segment"	Да	Тип источника данных
source_id	int	1	Да	Идентификатор источника данных
file_format	string	"csv"	Нет	Формат файла для экспорта. По умолчанию - csv.
custom_request	JSON object	{"occupation":"doctor"}	Нет	Поля профиля для уточнения поиска

Пример запроса

{
        "token": "e97ce55afc5e4e07bd64afb2227f8a5c",
        "source_type": "database",
        "source_id": 1,
		"file_format": "csv"
        
}

Пример ответа

{
    "data": {
        "task_id": "task_b2f9fd6a-2499-4a63-b592-f15d4e3b69c5"
    },
    "error": 0,
    "error_text": "Successful operation"
}

Возвращаемые параметры

Параметр	Тип	Описание
task_id	string	Идентификатор задания на экспорт
error	int	Код ошибки
error_text	string	Текст ошибки

2 - проверка статуса экспорта и получение ссылки

URL-адрес

Метод: POST

https://example.com/api/v1.1/tasks/status

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
task_id	string	"task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"	Да	Идентификатор задания

Пример запроса

{
        "token": "abcdefghijklmnqrstuvwxyz",
        "task_id": "task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"
        
}

Пример ответа

{
    "data": {
        "status": "success",
        "progress": 100,
        "result": {
            "source_id": 1,
            "total": 10,
            "type": "database",
            "urls": [
                "/api/download/6b248de2-39b9-4715-9720-5f4e23f4a296/1_database_export.csv"
            ]
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

Возвращаемые параметры

Параметр	Тип	Описание
status	string	Статус задания
progress	int	Прогресс выполнения
total	int	Количество профилей
urls	array	Ссылка на скачивание
error	int	Код ошибки
error_text	string	Текст ошибки

3 - скачивание результата

URL-адрес

Метод: GET

https://example.com/api/download/6b248de2-33b9-4715-9720-5f7e23f4a296/1_database_export.csv?token=abcdefghijklmnqrstuvwxyz

Ссылка получается предыдущим запросом.

Для скачивания файла необходимо передать в теле запроса API токен.