Get Reports - Dokumentacja MGBI API

Pobiera rekordy z informacjami o raportach spełniające podane kryteria.

W przypadku sukcesu w odpowiedzi zwraca paginowaną listę rekordów posortowaną według daty i czasu utworzenia raportu.

Jeśli dany raport został zlecony w trybie odświeżenia danych (type = "refresh"), to identyfikator zlecenia znajduje się w odpowiedzi pod kluczem refresh_id w strukturze query.

W przypadku braku rekordów spełniających podane kryteria zwraca pustą listę.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get reports list for actual user

application/json

Lista rekordów

Body

Example

{
    "content": [],
    "creation_datetime": "2025-12-18T14:17:50.192383+01:00",
    "downloads": [
        {
            "download_datetime": "2025-12-18T14:17:50.192320+01:00"
        }
    ],
    "file_encoding": "utf-8",
    "file_format": "xml",
    "file_password": "mgbi2021",
    "finish_datetime": "2025-12-18T14:17:50.192391+01:00",
    "id": "6943fefee9d923274ac9ba93",
    "name": "example raport",
    "progress": 0,
    "projection": "default",
    "query": {
        "identifiers.pl_nip": "123456789",
        "model": "pl-krz-wp-record"
    },
    "records_count": 3,
    "status": "preparing"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden