Получение item_set по дате/периоду

​

Параметры

• project_id (int, path, обязательный) - ID проекта
• date_from (date, query, опциональный) - Дата начала периода (YYYY-MM-DD)
• date_to (date, query, опциональный) - Дата окончания периода (YYYY-MM-DD)
• page (int, query, опциональный) - Номер страницы для пагинации
• per_page (int, query, опциональный) - Количество элементов на странице

​

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

​

Пример 1: Получение всех item_set проекта

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date" \
  -H "API-Access-Key: your access key"

​

Пример 2: Фильтр с определенной даты

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date?date_from=2024-01-15" \
  -H "API-Access-Key: your access key"

​

Пример 3: Фильтр до определенной даты

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date?date_to=2024-01-20" \
  -H "API-Access-Key: your access key"

​

Пример 4: Фильтр по периоду

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date?date_from=2024-01-15&date_to=2024-01-20" \
  -H "API-Access-Key: your access key"

​

Пример 5: С пагинацией и фильтром по дате

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date?date_from=2024-01-15&page=1&per_page=5" \
  -H "API-Access-Key: your access key"

​

Пример 6: За конкретный день

curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date?date_from=2024-01-15&date_to=2024-01-15" \
  -H "API-Access-Key: your access key"

​

Возможные ошибки

• 401 Unauthorized - Отсутствует или неверный токен аутентификации
• 403 Forbidden - Проект не принадлежит текущему пользователю
• 404 Not Found - Проект с указанным ID не найден
• 422 Unprocessable Entity - Неверный формат даты в параметрах
• 500 Internal Server Error - Внутренняя ошибка сервера

​

Логика фильтрации по дате

• Если указан только date_from - возвращаются item_set с этой даты и позже
• Если указан только date_to - возвращаются item_set до этой даты включительно
• Если указаны оба параметра - возвращаются item_set в указанном диапазоне
• Если параметры не указаны - возвращаются все item_set проекта

​

Статусы и их значения

​

Статусы item_set:

• added - добавлен, ожидает обработки
• processing - в процессе обработки
• processed - успешно обработан
• processing_failed - ошибка обработки

​

Статусы item_set в рамках проекта:

• added - добавлен в проект
• all_items_processed - все элементы обработаны
• processing - в процессе обработки
• processed - полностью обработан
• processing_failed - ошибка обработки

​

Дополнительные примеры использования

​

Примеры обработки ошибок:

​

Ошибка аутентификации:

# Запрос без токена
curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date"

# Ответ:
# HTTP/1.1 401 Unauthorized
{
  "detail": "Not authenticated"
}

​

Ошибка доступа к проекту:

# Запрос к проекту, к которому нет доступа
curl -X GET "https://api.spellit.ai/api/client/project/999/item-sets/by-date" \
  -H "API-Access-Key: your access key"

# Ответ:
# HTTP/1.1 403 Forbidden
{
  "detail": "Project not found or access denied"
}

​

Ошибка валидации даты:

# Неверный формат даты
curl -X GET "https://api.spellit.ai/api/client/project/123/item-sets/by-date?date_from=invalid-date" \
  -H "API-Access-Key: your access key"

# Ответ:
# HTTP/1.1 422 Unprocessable Entity
{
  "detail": [
    {
      "loc": ["query", "date_from"],
      "msg": "invalid date format",
      "type": "value_error.date"
    }
  ]
}