What's this error ...?

Error message: "Missing Authentication Token" (403)

Symptom: You are trying to call the API and you see a FORBIDDEN (403) response with this message in the body.

{
    "message": "Missing Authentication Token"
}

Problem: This is not an authentication issue. Either the url is wrong or the HTTP method is wrong (GET vs. POST).

Fix: Check the url and HTTP method against the API documentation the documentation. The following endpoints require a POST:

• POST {baseUrl}/v2/recent-datasource-measurements-query
• POST {baseUrl}/v2/recent-datasource-measurements-continuation
• POST {baseURl}/v2/report-requests

Error message: "Error Parsing JSON" (400)

Symptom: You are trying to call an API POST endpoint and you see a BAD REQUEST (400) response with this message in the body.

{
    "message": [
        "Error Parsing JSON"
    ]
}

Problem: The API is unable to interpret the body of your request as valid JSON. Or you didn't include a body in your request at all.

Fix: Make sure you are including a JSON body in your request and not query parameters. Make sure the JSON is well-formed.

Here is how Postman (a popular tool for testing apis) should be configured to send JSON formatted data in a POST call to our API:

Error message: "The request could not be satisfied" (403)

Symptom: You are trying to call a GET method on our API and the 403 response includes a full HTML page as a response with this title and further text saying "We can't connect to the server for this app or website at this time."

Problem: You have included a body in your GET request. Even an empty JSON object, {}, will cause this error.

Fix: Remove the body from your request and pass all parameters in the query parameters.

Here is how Postman (a popular tool for testing apis) should be configured to not send JSON in a GET call to our API:

Error message: "org ... not found" (404)

Symptom: You are trying to supply an org in a call and the org is not recognized.

Problem: The org identifier is a short, coded identifier for your organization. It is not the name displayed in the Dashboard.

Fix: To find the correct identifier for your organization, go to the Dashboard:

• Pick "Organization > Resources" from the menu.
• Under the word "Organization" you will find the label "Org ID:" and the correct identifier for your organization.
• Copy it to your clipboard by clicking on the icon to the right.

The correct value in the example image would be faqOrg123 (not Org for the FAQ).

Error message: "job limit of 30 reached for today" (429)

Symptom: You are trying to call POST /v2/report-requests and you have already called it 30 times since midnight UTC.

Problem: There is a limit of 30 report requests per day across your whole organization. This includes both the API endpoint and manual requests through Dashboard. You can see all the report requests together in Dashboard -- pick "Reports" from the top-level menu.

Fix: This mechanism is intended for large data pulls of low frequency. Ask for more data less frequently from this endpoint. Use the /v2/recent-datasource-measurements-query endpoint for near real-time updates.