Reporty

Poznámky
Expert level
Klíč API by měl být odeslán jako token Bearer v hlavičce Autorizace požadavku. Získejte klíč API.
Seznam

Koncový bod API:

GET 
https://okseo.net/api/v1/reports

Příklad žádosti: 

curl --location --request GET 'https://okseo.net/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
search
volitelné string
Hledaný dotaz.
search_by
volitelné string
Vyhledávání podle. Možné hodnoty jsou: :hodnota pro URL. Výchozí hodnota: url.
project
volitelné string
Název projektu.
result
volitelné string
The report result. Možné hodnoty jsou: :hodnota pro Dobré, :hodnota pro Slušné, :hodnota pro Špatné.
sort_by
volitelné string
Seřadit podle. Možné hodnoty jsou: :hodnota pro Datum vytvoření, :hodnota pro Datum vygenerování, :hodnota pro URL, :hodnota pro Výsledek. Výchozí hodnota: id.
sort
volitelné string
Třídit. Možné hodnoty jsou: :hodnota pro Sestupný, :hodnota pro Vzestupný. Výchozí hodnota: desc.
per_page
volitelné int
Výsledky na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 10.
Zobrazit

Koncový bod API:

GET 
https://okseo.net/api/v1/reports/{id}

Příklad žádosti: 

curl --location --request GET 'https://okseo.net/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Obchod

Koncový bod API:

POST 
https://okseo.net/api/v1/reports

Příklad žádosti: 

curl --location --request POST 'https://okseo.net/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametr
Typ
Popis
url
povinné string
The webpage's URL.
privacy
volitelné integer
Report page privacy. Možné hodnoty jsou: :hodnota pro Veřejný, :hodnota pro Soukromý, :hodnota pro Heslo. Výchozí hodnota: 1.
password
volitelné string
The password for the report page. Only works with privacy set to 2.
Aktualizace

Koncový bod API:

PUT PATCH 
https://okseo.net/api/v1/reports/{id}

Příklad žádosti: 

curl --location --request PUT 'https://okseo.net/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
privacy
volitelné integer
Report page privacy. Možné hodnoty jsou: :hodnota pro Veřejný, :hodnota pro Soukromý, :hodnota pro Heslo.
password
volitelné string
The password for the report page. Only works with privacy set to 2.
results
volitelné integer
Update the report results. Možné hodnoty jsou: :hodnota pro Ne, :hodnota pro Ano. Výchozí hodnota: 0.
Vymazat

Koncový bod API:

DELETE 
https://okseo.net/api/v1/reports/{id}

Příklad žádosti: 

curl --location --request DELETE 'https://okseo.net/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'