diff --git a/src/pages/kb/user-guide/integrations-and-api/api.md b/src/pages/kb/user-guide/integrations-and-api/api.md index 0e84d4f83..6805b285b 100644 --- a/src/pages/kb/user-guide/integrations-and-api/api.md +++ b/src/pages/kb/user-guide/integrations-and-api/api.md @@ -83,12 +83,15 @@ Here's an example JSON object including different parameter types: "end": "2020-12-31" } }, - "max_age": 1800 + "max_age": 1800 } +} ``` {% endcallout %} +### Jobs + `/api/jobs/` + GET: Returns a query task result (job) + Possible statuses: @@ -99,6 +102,8 @@ Here's an example JSON object including different parameter types: - 5 == CANCELLED + When status is success, the job will include a `query_result_id` +### Query Results + `/api/query_results/` + GET: Returns a query result - Appending a filetype of `.csv` or `.json` to this request will return a downloadable file. If you append your `api_key` in the query string, this link will work for non-logged-in users.