Reporty

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

API endpoint:

GET 
https://seo-tools.cz/api/v1/reports

Příklad požadavku: 

curl --location --request GET 'https://seo-tools.cz/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
search
ideální string
Vyhledávací dotaz.
search_by
ideální string
Hledat pomocí. Možné hodnoty jsou: url pro URL. Výchozí z: url.
project
ideální string
Název projektu.
result
ideální string
The report result. Možné hodnoty jsou: good pro Výborné, decent pro V pohodě, bad pro Velké špatné.
sort_by
ideální string
Třídít podle. Možné hodnoty jsou: id pro Datum vytvoření, generated_at pro Vygenerováno dne, url pro URL, result pro Výsledek. Výchozí z: id.
sort
ideální string
Třídit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí z: desc.
per_page
ideální int
Výsledků na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí z: 10.
Ukaž

API endpoint:

GET 
https://seo-tools.cz/api/v1/reports/{id}

Příklad požadavku: 

curl --location --request GET 'https://seo-tools.cz/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Úložiště

API endpoint:

POST 
https://seo-tools.cz/api/v1/reports

Příklad požadavku: 

curl --location --request POST 'https://seo-tools.cz/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametr
Typ
Popis
url
vyžadováno string
The webpage's URL.
privacy
ideální integer
Report page privacy. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro heslo. Výchozí z: 1.
password
ideální string
The password for the report page. Only works with privacy set to 2.
Aktualizace

API endpoint:

PUT PATCH 
https://seo-tools.cz/api/v1/reports/{id}

Příklad požadavku: 

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

API endpoint:

DELETE 
https://seo-tools.cz/api/v1/reports/{id}

Příklad požadavku: 

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