Raporty

Notatki
Expert level
Klucz API powinien być przesyłany jako token Bearer w nagłówku Autoryzacji żądania. Pobierz swój klucz API.
Lista

Punkt końcowy API:

GET 
https://seoapp.nexeo.cloud/api/v1/reports

Przykład żądania: 

curl --location --request GET 'https://seoapp.nexeo.cloud/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Opis
search
opcjonalne string
Zapytanie wyszukiwania.
search_by
opcjonalne string
Szukaj według. Możliwe wartości to: url dla URL. Domyślnie: url.
project
opcjonalne string
Nazwa projektu.
result
opcjonalne string
The report result. Możliwe wartości to: good dla Dobry, decent dla Przyzwoity, bad dla Zły.
sort_by
opcjonalne string
Sortuj według. Możliwe wartości to: id dla Data utworzenia, generated_at dla Data wygenerowania, url dla URL, result dla Wynik. Domyślnie: id.
sort
opcjonalne string
Sortuj. Możliwe wartości to: desc dla Malejąco, asc dla Rosnąco. Domyślnie: desc.
per_page
opcjonalne int
Wyników na stronę. Możliwe wartości to: 10, 25, 50, 100. Domyślnie: 10.
Pokaż

Punkt końcowy API:

GET 
https://seoapp.nexeo.cloud/api/v1/reports/{id}

Przykład żądania: 

curl --location --request GET 'https://seoapp.nexeo.cloud/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Zapisz

Punkt końcowy API:

POST 
https://seoapp.nexeo.cloud/api/v1/reports

Przykład żądania: 

curl --location --request POST 'https://seoapp.nexeo.cloud/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametr
Typ
Opis
url
wymagane string
The webpage's URL.
privacy
opcjonalne integer
Report page privacy. Możliwe wartości to: 0 dla Publiczne, 1 dla Prywatne, 2 dla Hasło. Domyślnie: 1.
password
opcjonalne string
The password for the report page. Only works with privacy set to 2.
Aktualizuj

Punkt końcowy API:

PUT PATCH 
https://seoapp.nexeo.cloud/api/v1/reports/{id}

Przykład żądania: 

curl --location --request PUT 'https://seoapp.nexeo.cloud/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Opis
privacy
opcjonalne integer
Report page privacy. Możliwe wartości to: 0 dla Publiczne, 1 dla Prywatne, 2 dla Hasło.
password
opcjonalne string
The password for the report page. Only works with privacy set to 2.
results
opcjonalne integer
Update the report results. Możliwe wartości to: 0 dla Nie, 1 dla Tak. Domyślnie: 0.
Usuń

Punkt końcowy API:

DELETE 
https://seoapp.nexeo.cloud/api/v1/reports/{id}

Przykład żądania: 

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