Reports

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET
https://seoheartbeat.com/api/v1/reports

Request example:

curl --location --request GET 'https://seoheartbeat.com/api/v1/reports' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optionalstring
The search query.
search_by
optionalstring
Search by. Possible values are: url for URL. Defaults to: url.
project
optionalstring
The project name.
result
optionalstring
The report result. Possible values are: good for Good, decent for Decent, bad for Bad.
sort_by
optionalstring
Sort by. Possible values are: id for Date created, generated_at for Date generated, url for URL, result for Result. Defaults to: id.
sort
optionalstring
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optionalint
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 25.
Show

API endpoint:

GET
https://seoheartbeat.com/api/v1/reports/{id}

Request example:

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

API endpoint:

POST
https://seoheartbeat.com/api/v1/reports

Request example:

curl --location --request POST 'https://seoheartbeat.com/api/v1/reports' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'url={url}'
Parameter
Type
Description
url
requiredstring
The webpage's URL.
privacy
optionalinteger
Report page privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password. Defaults to: 1.
password
optionalstring
The password for the report page. Only works with privacy set to 2.
Update

API endpoint:

PUTPATCH
https://seoheartbeat.com/api/v1/reports/{id}

Request example:

curl --location --request PUT 'https://seoheartbeat.com/api/v1/reports/{id}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
privacy
optionalinteger
Report page privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password.
password
optionalstring
The password for the report page. Only works with privacy set to 2.
Delete

API endpoint:

DELETE
https://seoheartbeat.com/api/v1/reports/{id}

Request example:

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