Последние отчёты

Метод SerpstatReportsProcedure.getLatestReports позволяет получить информацию о сгенерированных отчетах пользователя и скачать их. Данные аналогичны отчету «‎Последние отчёты».

Общие параметры запроса

Параметры запроса
Параметр	Описание	Тип данных	Опциональный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор.	int/string	нет		Текстовое или числовое значение
method	Название метода API	string	нет		SerpstatReportsProcedure.getLatestReports
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры		да
filters	Условия фильтрации	array	да		"query" – фильтр по содержанию запроса в названии отчёта. Например: "query": "some string value"
sort	Сортировка по данным (по возрастанию и убыванию)	array	да	"date": "desc"	"date" – сортировка по дате, "se" – по поисковой базе, "status" – по статусу отчёта, "query" – по названию, "format" – по формату (asc — по возрастанию, desc — по убыванию)
page	Номер страницы в ответе	int	да	1	"page": 1 (любое числовое значение)
size	Количество результатов на страницу в ответе	int	да	20	"size": 10 (любое числовое значение) min: 1, max: 100

Параметры ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Содержит в себе ответ
data	Массив с данными ответа
format	Формат отчёта. Возможные варианты: mgxlsx – формат экспорта аудита Serpstat, аналогичен формату xlsx, csv – формат файла данных с разделителями-запятыми, csv_cp1251 – формат файла данных с разделителями-запятыми с кодировкой cp1251, xlsx – XML-формат файла Microsoft Excel, xls – формат файла Microsoft Excel, gdrive – формат файла который хранится на Google Drive, pdf – универсальный файловый формат переносимых документов, pupetter_pdf – формат файла, который генерирует pdf из html страницы, mgxlsx_mfiles – формат экспорта аудита Serpstat, аналогичен формату xlsx, kv_xls – формат экспорта списка ошибок валидации в кластеризации Serpstat, аналогичен формату xls.
status	Статус отчёта -1 – ошибка генерации 0 – генерация в процессе 1 – сгенерирован, но не скачан 2 – сгенерирован и скачан 3 – превышено количество лимитов 4 – удалён пользователем
created	Дата создания отчёта
query	Название отчёта
request	Название запроса, по которому сгенерирован отчёт. Например Audit_Dashboard, backlink_top_pages и т.д.
se	Поисковая база, по которой был сгенерирован отчёт
file	Ссылка для скачивания отчёта
summary_info	Объект с данными ответа
left_lines	Количество оставшихся API строк
total_reports	Количество отчётов на аккаунте пользователя
sort	Применённая в запросе сортировка
page	Номер страницы в ответе
size	Количество результатов на страницу в ответе

Лимиты за этот метод не списываются.

Example

Request data:

{
    "id": 1,
    "method": "SerpstatReportsProcedure.getLatestReports",
    "params": {
                "filters": {"query": ""},
                "sort": {"status": "desc"},
                "page": 1,
                "size": 20
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "format": "csv",
                "status": "1",
                "created": "2022-11-16 06:44:28",
                "query": "premierleague.com",
                "request": "positions",
                "se": "Google.UK",
                "file": "https://docs.serpstat.com/files/reports/5/positions_premierleague_com-2022-11-16_06-44-32_Google_UK.63746ab0a8707.csv"
            },
            {
                "format": "csv",
                "status": "1",
                "created": "2022-11-16 06:46:52",
                "query": "manutd.com",
                "request": "urls_with_shares",
                "se": "Google.UK",
                "file": "https://docs.serpstat.com/files/reports/52/urls_with_shares_manutd_com-2022-11-16_06-46-53_Google_UK.63746b3d25c83.csv"
            },
            {
                "format": "mgxlsx",
                "status": "1",
                "created": "2022-11-17 01:30:46",
                "query": "teepublic.com-2022-11-17-00-03_report",
                "request": "Audit_Dashboard",
                "se": "",
                "file": "https://docs.serpstat.com/files/reports/81/Audit_Dashboard_teepublic_com-2022-11-17-00-03_report-2022-11-17_01-30-47_Google_UA.637572a76043a.xlsx"
            },
            {
                "format": "gdrive",
                "status": "1",
                "created": "2022-11-21 06:56:23",
                "query": "twitter.com",
                "request": "positions",
                "se": "Google.UA",
                "file": "https://drive.google.com/open?id=1e-XxOPi9qkd2HOXbvF4jwtvNndrdO9gVDJ5afmBg02s"
            }
        ],
        "summary_info": {
            "left_lines": 1000000,
            "total_reports": 4,
            "sort": {
                "status": "desc"
            },
            "page": 1,
            "size": 20
        }
    }
}