API v2

Запуск DQ

POST /api/v2/run_dq

Запускает процесс DQ для группы проверок за определенную дату.
Параметры в теле запроса:

Параметр	Тип	Значение по умолчанию	Описание
check_group_name	string		Наименование группы проверки
check_date	string	Дата в момент запуска	Дата проверки

Ответ:

Status code	Атрибут	Тип	Описание
200	run_id	string	уникальный идентификатор DQ процесса для его отслеживания в методе get_job_status
404	errors	string	описание ошибки

Пример:

curl -X POST "localhost:8000/api/v2/run_dq" --data "{\"check_group_name\": \"test_spark\", \"check_date\": \"2025-01-10\"}" -H "Content-Type: application/json"

{"run_id":"60658a25-7f1f-42b3-9437-c8b4ce6dc287"}

GET /api/v2/run_dq

Запускает процесс DQ для группы проверок за определенную дату.
Параметры запроса:

Параметр	Тип	Значение по умолчанию	Описание
check_group_name	string		Наименование группы проверки
check_date	string	Дата в момент запуска	Дата проверки

Ответ:

Status code	Атрибут	Тип	Описание
200	run_id	string	уникальный идентификатор DQ процесса для его отслеживания в методе get_job_status
404	errors	string	описание ошибки

Пример:

curl -X GET "localhost:8000/api/v2/run_dq?check_group_name=test_spark&check_date=2025-01-10"

{"run_id":"93377e9a-dfa0-422c-9b1c-5f38e7087a7c"}

GET /api/v2/get_job_status

Возвращает статус процесса DQ, завершен он или еще в процессе

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

Параметр	Тип	Описание
run_id	string	Идентификатор процесса, который был получен в результате вызова /api/v2/run_dq

Ответ:

Status code	Атрибут	Тип	Описание
200	run_id	string, enum: ['RUNNING\', 'FINISHED\', 'FAILED\']	Статус задачи: RUNNING, FINISHED или FAILED
404	errors	string	описание ошибки

Пример:

curl -X GET "localhost:8000/api/v2/get_job_status?run_id=93377e9a-dfa0-422c-9b1c-5f38e7087a7c"

{"response":"RUNNING"}

Агрегированный статус группы проверок

Возможные значения статуса группы проверок:

check_status	Описание
0	Нет значения метрики, относительно которой происходит сравнение (reference_metric)
1	Проверки прошли успешно
-1	Проверки прошли не успешно (несоответствие пороговым значениям из правила проверки)
-2	Нет значения метрики
-3	Процесс DQ не завершился корректно, либо не был запущен

GET /api/v2/check_group_status

Возвращает статус проверки по дате проверки и наименованию группы проверки

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

Параметр	Тип	Описание
check_group_name	string	Наименование группы проверки
check_date	string	Дата проверки

Ответ:

Status code	Атрибут	Тип	Описание
200	check_date	string	Дата проверки
	status	integer	Статус группы проверок
400	error	string	Описание ошибки

Пример:

curl -X GET "localhost:8000/api/v2/check_group_status?check_group_name=test_spark&check_date=2025-01-10"

{"2020-08-01":-3}

GET /api/v2/check_group_status_range

Возвращает статусы проверок за определенный диапазон дат

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

Параметр	Тип	Описание
check_group_name	string	Наименование группы проверки
date_from	string	Дата начала
date_to	string	Дата окончания

Ответ:

Status code	Атрибут	Тип	Описание
200	check_date	string	Дата проверки
	status	integer	Статус группы проверок
404	error	string	Описание ошибки

Пример:

curl -X GET "localhost:8000/api/v2/check_group_status_range?check_group_name=test_spark&date_from=2025-01-01&date_to=2025-01-03"

{"2025-01-01":-3,"2025-01-02":-3,"2025-01-03":-3}