Report Read

Przeglądanie gotowych raportów.

GET /report

Query Parameters

Możliwe parametry w URL:

Parametr	Domyślnie	Przykład	Opis
limit	100	500	Limit pobranych rekordów
offset	0	0	Rekord początkowy
sort	created_date_utc	report_name	Klucz sortowania
dir	asc	desc	Kierunek sortowania
filter	NULL	[{"property": "report_name", "value": "Report name"}, {"property": "created_date_utc", "operator: "gt", "value": "2022-08-15 02:20:00"}]	Filtrowanie po parametrze

Dostępne parametry dla sort:

• _id - <STRING>
• report_name - <STRING>
• created_date_utc - <STRING>
  
  

Dostępne parametry dla dir:

• asc - <STRING>
• desc - <STRING>
  
  

Dostępne parametry dla filter:

• report_name
  • property - <STRING>
  • value - <STRING>
• created_date_utc
  • property - <STRING>
  • operator - <STRING>
    • lt
    • gt
    • lte
    • gte
    • eq
  • value - <STRING>

Parametr filter musi być listą obiektów przekształconą w ciąg JSON zakodowany w UTF-8.

Przykład przekształcenia:

encodeURI(JSON.stringify([{"property": "report_name", "value": "Report name"}]))

Przekształcona wartość:

%5B%7B%22property%22:%22report_name%22,%22value%22:%22Report%20name%22%7D%5D

Response Body

{
    "success": true,
    "data": <LIST<Report>>,
    "count": <INTEGER>,
}

Nazwa	Rodzaj	Opis	Zasób
data	<LIST<Report>>	Lista obiektów	Report

Response Code

Status	Opis
200	Rekordy zostały pobrane pomyślnie
400	Błąd żądania

Example

CURLPYTHONPHP

curl -X GET \
    $CONPEEK_URL/report \
    -H 'Authorization: '$CONPEEK_KEY \
    -H 'Content-Type: application/json'

import requests
import os
from urllib import parse

url = parse.urljoin(os.environ["CONPEEK_URL"], "report")

headers = {
    'Content-Type': "application/json",
    'Authorization': os.environ["CONPEEK_KEY"]
}

response = requests.request("GET", url, headers=headers)
print(response.text)

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/report",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: ".getenv("CONPEEK_KEY"),
        "Content-Type: application/json"
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}