Reports
Zlecenie raportu
Tworzy zlecenie raportu KRZ lub MSiG dla wybranego zakresu dat (maksymalny zakres zależy od konfiguracji — patrz limit w abonamencie). Raporty są generowane asynchronicznie; status sprawdzaj endpointem /v1/reports/status/{job_id}. Funkcja wymaga planu Pro lub wyższego.
POST
/
v1
/
reports
/
submit
Zlecenie raportu
curl --request POST \
--url https://api.krdata.pl/v1/reports/submit \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"source": "<string>",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"format": "json",
"filter_id": "<string>"
}
'import requests
url = "https://api.krdata.pl/v1/reports/submit"
payload = {
"source": "<string>",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"format": "json",
"filter_id": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: '<string>',
from_date: '2023-12-25',
to_date: '2023-12-25',
format: 'json',
filter_id: '<string>'
})
};
fetch('https://api.krdata.pl/v1/reports/submit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.krdata.pl/v1/reports/submit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'source' => '<string>',
'from_date' => '2023-12-25',
'to_date' => '2023-12-25',
'format' => 'json',
'filter_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.krdata.pl/v1/reports/submit"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"from_date\": \"2023-12-25\",\n \"to_date\": \"2023-12-25\",\n \"format\": \"json\",\n \"filter_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.krdata.pl/v1/reports/submit")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"from_date\": \"2023-12-25\",\n \"to_date\": \"2023-12-25\",\n \"format\": \"json\",\n \"filter_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.krdata.pl/v1/reports/submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"from_date\": \"2023-12-25\",\n \"to_date\": \"2023-12-25\",\n \"format\": \"json\",\n \"filter_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"source": "<string>",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"output_format": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"filter_id": "<string>",
"row_count": 123,
"size_bytes": 123,
"error": "<string>",
"completed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
Response
Successful Response
Previous
Lista raportówLista zleconych raportów niestandardowych użytkownika z możliwością filtrowania po statusie (`preparing`, `ready`, `failed`).
Next
⌘I
Zlecenie raportu
curl --request POST \
--url https://api.krdata.pl/v1/reports/submit \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"source": "<string>",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"format": "json",
"filter_id": "<string>"
}
'import requests
url = "https://api.krdata.pl/v1/reports/submit"
payload = {
"source": "<string>",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"format": "json",
"filter_id": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: '<string>',
from_date: '2023-12-25',
to_date: '2023-12-25',
format: 'json',
filter_id: '<string>'
})
};
fetch('https://api.krdata.pl/v1/reports/submit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.krdata.pl/v1/reports/submit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'source' => '<string>',
'from_date' => '2023-12-25',
'to_date' => '2023-12-25',
'format' => 'json',
'filter_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.krdata.pl/v1/reports/submit"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"from_date\": \"2023-12-25\",\n \"to_date\": \"2023-12-25\",\n \"format\": \"json\",\n \"filter_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.krdata.pl/v1/reports/submit")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"from_date\": \"2023-12-25\",\n \"to_date\": \"2023-12-25\",\n \"format\": \"json\",\n \"filter_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.krdata.pl/v1/reports/submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"from_date\": \"2023-12-25\",\n \"to_date\": \"2023-12-25\",\n \"format\": \"json\",\n \"filter_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"source": "<string>",
"from_date": "2023-12-25",
"to_date": "2023-12-25",
"output_format": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"filter_id": "<string>",
"row_count": 123,
"size_bytes": 123,
"error": "<string>",
"completed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}