Документация API JCat.Работа

Получение статистики

Получение ссылок на размещения вакансии

GET /v1/orders/{id}/urls

Обязательные параметры:

ИмяТипОписание
 id integerИдентификатор вакансии

 Результат запроса 

 Заголовок:

  • 200 OK - успешное выполнение
  • 404 Not Found - вакансия не найдена
  • 403 Forbidden - вакансия недоступна данному пользователю

 Тело ответа:

count - количество ссылок, доступных в данный момент
id - 
идентификатор сайта
title - 
название сайта
url - 
ссылка на размещение (либо поясняющее сообщение)

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

{
    "data": {
        "count": 2,
        "items": [
            {
                "id": 1,
                "title": "Название сайта",
                "url": "https://example.com/link"
            },
            {
                "id": 2,
"title": "Название сайта 2",
"url": "Вакансия размещена, ссылка на вакансию не предоставляется из-за особенностей сайта"
            },
        ]
    }
}

Получение общей статистики просмотров

GET /v1/orders/{id}/stats/views/boards

Обязательные параметры:

ИмяТипОписание
 id integerИдентификатор вакансии

Необязательные GET-параметры:

ИмяТипОписание
 from DatetimeДата в формате 'Y-m-d'
 to DatetimeДата в формате 'Y-m-d'

 Результат запроса 

  • 200 OK - успешное выполнение
  • 404 Not Found - вакансия не найдена
  • 403 Forbidden - вакансия недоступна данному пользователю

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

{
    "from": "2015-02-01",
    "to": "2018-02-01",
    "summary": 1473,
    "views": {
        [
            {
                "title": "Cian",
                "url": "http://cian.ru",
                "views": 231
            },
            {
                "title": "Avito",
                "url": "http://avito.ru",
                "views": 1242
            },
        ]
    }
}

Если сайт не собирает статистику просмотров, тело ответа будет включать следующий контент:

            {
                "title": "Новосёл",
                "url": "http://novosel.ru",
                "error": "Сайт не собирает статистику просмотров"
            }

Получение общей статистики просмотров телефона по вакансии

GET /v1/orders/{id}/stats/calls/boards

Обязательные параметры:

ИмяТипОписание
 id integerИдентификатор вакансии

Необязательные GET-параметры:

ИмяТипОписание
 from DatetimeДата в формате 'Y-m-d'
 to DatetimeДата в формате 'Y-m-d'

 Результат запроса 

  • 200 OK - успешное выполнение
  • 404 Not Found - вакансия не найдена
  • 403 Forbidden - вакансия недоступна данному пользователю

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

{
    "from": "2015-02-06",
    "to": "2018-02-06",
    "summary": 1473,
    "views": {
        [
            {
                "title": "HH",
                "url": "http://hh.ru",
                "views": 231
            },
            {
                "title": "Avito",
                "url": "http://avito.ru",
                "views": 1242
            }
        ]
    }
}

Если сайт не собирает статистику просмотров телефона, тело ответа будет содержать следующий контент:

            {
                "title": "Site",
                "url": "http://example.ru",
                "error": "Сайт не собирает статистику просмотров"
            }


Получение списка ошибок при размещении вакансии

GET /v1/orders/{id}/errors

Обязательные параметры:

ИмяТипОписание
 id integerИдентификатор вакансии

 Результат запроса 

 Заголовок:

  • 200 OK - успешное выполнение
  • 404 Not Found - вакансия не найдена
  • 403 Forbidden - вакансия недоступна данному пользователю

 Тело ответа:

id - идентификатор сайта
title - 
название сайта
error - 
текст ошибки

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

{
    "data": {
        "count": 2,
        "items": [
            {
                "id": 1,
                "title": "Название сайта",
                "error": "Запрещается указывать в вакансии пустое поле"
            },
            {
                "id": 2,
"title": "Название сайта 2",
"error": "Запрещается размещать в вакансии недостоверную информацию"
            },
        ]
    }
}