From 1af29c80fd829dceb2dca1e71a5bf95de0a2610a Mon Sep 17 00:00:00 2001 From: "F. Eugene Aumson" Date: Sat, 23 Oct 2021 07:01:39 -0600 Subject: [PATCH 1/2] docs: Prettify example JSON object --- src/pages/kb/user-guide/integrations-and-api/api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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..2f53ca6d2 100644 --- a/src/pages/kb/user-guide/integrations-and-api/api.md +++ b/src/pages/kb/user-guide/integrations-and-api/api.md @@ -83,8 +83,9 @@ Here's an example JSON object including different parameter types: "end": "2020-12-31" } }, - "max_age": 1800 + "max_age": 1800 } +} ``` {% endcallout %} From a44e2296dc4bf3ed4bc00b2622939f095864026c Mon Sep 17 00:00:00 2001 From: "F. Eugene Aumson" Date: Sat, 23 Oct 2021 07:14:58 -0600 Subject: [PATCH 2/2] docs/api: Add headings for Jobs & Query Results --- src/pages/kb/user-guide/integrations-and-api/api.md | 4 ++++ 1 file changed, 4 insertions(+) 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 2f53ca6d2..6805b285b 100644 --- a/src/pages/kb/user-guide/integrations-and-api/api.md +++ b/src/pages/kb/user-guide/integrations-and-api/api.md @@ -90,6 +90,8 @@ Here's an example JSON object including different parameter types: {% endcallout %} +### Jobs + `/api/jobs/` + GET: Returns a query task result (job) + Possible statuses: @@ -100,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.