Get a report's status
const url = 'https://api.recomention.com/v1/reports/example/status';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.recomention.com/v1/reports/example/status \ --header 'Authorization: Bearer <token>'Where a report is, with answers stored so far. Poll about once a minute.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The status.
object
object
The report page.
A test run with made-up answers. Draw no conclusions from it.
Example
{ "status": { "status": "PENDING", "funding": "BYOK" }}Missing, malformed, unknown or revoked API key.
object
What went wrong, in plain words. Never repeats a submitted secret.
Request fields to fix (400).
Seconds to wait before retrying (429).
Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.
The report’s status, when it explains the refusal (409).
Example generated
{ "error": "example", "fields": [ "example" ], "retryAfterSeconds": 1, "limit": "example", "status": "example"}Not found. Someone else’s report answers the same as a missing one.
object
What went wrong, in plain words. Never repeats a submitted secret.
Request fields to fix (400).
Seconds to wait before retrying (429).
Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.
The report’s status, when it explains the refusal (409).
Example generated
{ "error": "example", "fields": [ "example" ], "retryAfterSeconds": 1, "limit": "example", "status": "example"}Rate limited. Wait Retry-After seconds.
object
What went wrong, in plain words. Never repeats a submitted secret.
Request fields to fix (400).
Seconds to wait before retrying (429).
Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.
The report’s status, when it explains the refusal (409).
Example generated
{ "error": "example", "fields": [ "example" ], "retryAfterSeconds": 1, "limit": "example", "status": "example"}Headers
Section titled “Headers”Seconds to wait.
Requests allowed in the window.
Requests left in the window (0 on a 429).
Seconds until the window resets.
A dependency is briefly unavailable. Retry after Retry-After seconds.
object
What went wrong, in plain words. Never repeats a submitted secret.
Request fields to fix (400).
Seconds to wait before retrying (429).
Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.
The report’s status, when it explains the refusal (409).
Example generated
{ "error": "example", "fields": [ "example" ], "retryAfterSeconds": 1, "limit": "example", "status": "example"}Headers
Section titled “Headers”Seconds to wait.