Документи
Отримати результати документа
Переглянути статус і витягнуті лабораторні показники завантаженого тобою документа
GET
/
api
/
v1
/
documents
/
{id}
/
results
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
Прочитай статус і лабораторні показники документа, завантаженого через
Завантажити документ. Відповідь має таку саму структуру, як у
Отримати результати аналізів для запису. Опис кожного поля — у розділі
Результати.
Відповідають лише документи, завантажені в групу профілів, у якій твій ключ може читати результати. Для всіх інших
документів повертається
404: читай їхні результати через запис або замовлення набору для домашнього тесту, у межах яких їх створено.
Опитувати API не потрібно. Підпишись на вебхуки document.results.updated або document.results.completed
і викликай цей ендпоінт, коли надійде подія.
Потрібен дозвіл results_view для групи профілів, у яку завантажено документ.
Запит
Параметри шляху
Заголовки
Значення
ETag із попередньої відповіді. Якщо нічого не змінилося, API відповідає 304 Not Modified
без тіла відповіді.Відповідь
У разі успіху API повертає200 OK з об’єктом результатів і заголовком ETag.
Одне зі значень:
in_progress— Aniva витягує значення.completed— витягування завершено.fault— помилка витягування.stored— у документі немає значень: його завантажено безextract_resultsабо він не містить лабораторних результатів. Статусstoredостаточний: вебхукdocument.results.completedпісля нього не надходить.
Витягнуті значення. Кожне значення має
origin: partner_upload. Якщо у звіті кілька дат
забору зразків, кожне значення отримує власне tested_at. Ніколи не буває planned: завантаження нічого не замовляє.Відповіді з помилками
| Статус | Опис |
|---|---|
304 | Не змінено — etag із If-None-Match досі збігається. Без тіла відповіді. |
400 | Неправильний формат ID. |
403 | Твоєму API-ключу бракує дозволу results_view. |
404 | Жоден документ, завантажений у твої групи профілів, не має такого ID. |
500 | Внутрішня помилка сервера. |
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}