Update an existing query
curl --request PATCH \
--url https://api.ctrl-hub.com/v3/queries/{query_id} \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "queries",
"attributes": {
"name": "<string>",
"description": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"decimals": 5,
"resolution": {
"projections": [
{
"path": [
"<string>"
],
"attribute": "<string>",
"label": "<string>"
}
]
}
}
],
"group_by": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"bin": {
"from": 123,
"width": 123,
"to": 123,
"thresholds": [
123
]
}
}
],
"measures": [
{
"key": "<string>",
"type": "<string>",
"percentile": 50,
"decimals": 5,
"label": "<string>"
}
],
"filters": [
{
"key": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"sort": [
{
"key": "<string>"
}
],
"column_order": [
"<string>"
]
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/queries/{query_id}"
payload = { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "queries",
"attributes": {
"name": "<string>",
"description": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"decimals": 5,
"resolution": { "projections": [
{
"path": ["<string>"],
"attribute": "<string>",
"label": "<string>"
}
] }
}
],
"group_by": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"bin": {
"from": 123,
"width": 123,
"to": 123,
"thresholds": [123]
}
}
],
"measures": [
{
"key": "<string>",
"type": "<string>",
"percentile": 50,
"decimals": 5,
"label": "<string>"
}
],
"filters": [
{
"key": "<string>",
"op": "<string>",
"values": ["<string>"]
}
],
"sort": [{ "key": "<string>" }],
"column_order": ["<string>"]
}
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: 'queries',
attributes: {
name: '<string>',
description: '<string>',
fields: [
{
key: '<string>',
label: '<string>',
type: '<string>',
decimals: 5,
resolution: {projections: [{path: ['<string>'], attribute: '<string>', label: '<string>'}]}
}
],
group_by: [
{
key: '<string>',
label: '<string>',
type: '<string>',
bin: {from: 123, width: 123, to: 123, thresholds: [123]}
}
],
measures: [
{
key: '<string>',
type: '<string>',
percentile: 50,
decimals: 5,
label: '<string>'
}
],
filters: [{key: '<string>', op: '<string>', values: ['<string>']}],
sort: [{key: '<string>'}],
column_order: ['<string>']
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/queries/{query_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ctrl-hub.com/v3/queries/{query_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'queries',
'attributes' => [
'name' => '<string>',
'description' => '<string>',
'fields' => [
[
'key' => '<string>',
'label' => '<string>',
'type' => '<string>',
'decimals' => 5,
'resolution' => [
'projections' => [
[
'path' => [
'<string>'
],
'attribute' => '<string>',
'label' => '<string>'
]
]
]
]
],
'group_by' => [
[
'key' => '<string>',
'label' => '<string>',
'type' => '<string>',
'bin' => [
'from' => 123,
'width' => 123,
'to' => 123,
'thresholds' => [
123
]
]
]
],
'measures' => [
[
'key' => '<string>',
'type' => '<string>',
'percentile' => 50,
'decimals' => 5,
'label' => '<string>'
]
],
'filters' => [
[
'key' => '<string>',
'op' => '<string>',
'values' => [
'<string>'
]
]
],
'sort' => [
[
'key' => '<string>'
]
],
'column_order' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ctrl-hub.com/v3/queries/{query_id}"
payload := strings.NewReader("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"queries\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"decimals\": 5,\n \"resolution\": {\n \"projections\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"attribute\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"group_by\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"bin\": {\n \"from\": 123,\n \"width\": 123,\n \"to\": 123,\n \"thresholds\": [\n 123\n ]\n }\n }\n ],\n \"measures\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"percentile\": 50,\n \"decimals\": 5,\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"op\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"sort\": [\n {\n \"key\": \"<string>\"\n }\n ],\n \"column_order\": [\n \"<string>\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ctrl-hub.com/v3/queries/{query_id}")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"queries\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"decimals\": 5,\n \"resolution\": {\n \"projections\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"attribute\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"group_by\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"bin\": {\n \"from\": 123,\n \"width\": 123,\n \"to\": 123,\n \"thresholds\": [\n 123\n ]\n }\n }\n ],\n \"measures\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"percentile\": 50,\n \"decimals\": 5,\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"op\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"sort\": [\n {\n \"key\": \"<string>\"\n }\n ],\n \"column_order\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/queries/{query_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"queries\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"decimals\": 5,\n \"resolution\": {\n \"projections\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"attribute\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"group_by\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"bin\": {\n \"from\": 123,\n \"width\": 123,\n \"to\": 123,\n \"thresholds\": [\n 123\n ]\n }\n }\n ],\n \"measures\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"percentile\": 50,\n \"decimals\": 5,\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"op\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"sort\": [\n {\n \"key\": \"<string>\"\n }\n ],\n \"column_order\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "queries",
"attributes": {
"name": "<string>",
"dataset": "form-submissions",
"mode": "detail",
"description": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"decimals": 5,
"resolution": {
"projections": [
{
"path": [
"<string>"
],
"attribute": "<string>",
"label": "<string>",
"multi_value": "join"
}
]
}
}
],
"group_by": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"bucket": "day",
"bin": {
"from": 123,
"width": 123,
"to": 123,
"thresholds": [
123
]
}
}
],
"measures": [
{
"func": "count",
"key": "<string>",
"type": "<string>",
"percentile": 50,
"decimals": 5,
"label": "<string>"
}
],
"filters": [
{
"key": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"sort": [
{
"key": "<string>",
"direction": "asc"
}
],
"column_order": [
"<string>"
]
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"form": {
"data": {
"type": "forms",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
},
"jsonapi": {
"version": "1.0"
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations",
"attributes": {
"name": "Acme Construction Ltd",
"slug": "acme-construction",
"sandbox": false,
"description": "Leading construction company specializing in infrastructure projects",
"settings": {
"teams": {
"customer_representatives": [
"b234c567-8901-2345-6789-abcdef012345"
]
}
}
},
"meta": {
"v3": true,
"status": "active",
"created_at": "2023-01-15T10:30:00.000Z",
"updated_at": "2023-02-20T14:45:00.000Z",
"features": [
{
"name": "advanced_reporting",
"enabled": true,
"limit": 1000
}
]
},
"relationships": {
"users": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
]
},
"service_accounts": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "service-accounts"
}
]
},
"groups": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "groups"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "teams"
}
]
},
"nomenclature": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "nomenclature"
}
}
}
}
]
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f",
"status": "404",
"title": "Resource not found",
"detail": "The requested resource could not be found or does not exist.",
"code": "NOT_FOUND.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Queries
Update a query
Update an existing query definition.
PATCH
/
v3
/
queries
/
{query_id}
Update an existing query
curl --request PATCH \
--url https://api.ctrl-hub.com/v3/queries/{query_id} \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "queries",
"attributes": {
"name": "<string>",
"description": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"decimals": 5,
"resolution": {
"projections": [
{
"path": [
"<string>"
],
"attribute": "<string>",
"label": "<string>"
}
]
}
}
],
"group_by": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"bin": {
"from": 123,
"width": 123,
"to": 123,
"thresholds": [
123
]
}
}
],
"measures": [
{
"key": "<string>",
"type": "<string>",
"percentile": 50,
"decimals": 5,
"label": "<string>"
}
],
"filters": [
{
"key": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"sort": [
{
"key": "<string>"
}
],
"column_order": [
"<string>"
]
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/queries/{query_id}"
payload = { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "queries",
"attributes": {
"name": "<string>",
"description": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"decimals": 5,
"resolution": { "projections": [
{
"path": ["<string>"],
"attribute": "<string>",
"label": "<string>"
}
] }
}
],
"group_by": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"bin": {
"from": 123,
"width": 123,
"to": 123,
"thresholds": [123]
}
}
],
"measures": [
{
"key": "<string>",
"type": "<string>",
"percentile": 50,
"decimals": 5,
"label": "<string>"
}
],
"filters": [
{
"key": "<string>",
"op": "<string>",
"values": ["<string>"]
}
],
"sort": [{ "key": "<string>" }],
"column_order": ["<string>"]
}
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: 'queries',
attributes: {
name: '<string>',
description: '<string>',
fields: [
{
key: '<string>',
label: '<string>',
type: '<string>',
decimals: 5,
resolution: {projections: [{path: ['<string>'], attribute: '<string>', label: '<string>'}]}
}
],
group_by: [
{
key: '<string>',
label: '<string>',
type: '<string>',
bin: {from: 123, width: 123, to: 123, thresholds: [123]}
}
],
measures: [
{
key: '<string>',
type: '<string>',
percentile: 50,
decimals: 5,
label: '<string>'
}
],
filters: [{key: '<string>', op: '<string>', values: ['<string>']}],
sort: [{key: '<string>'}],
column_order: ['<string>']
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/queries/{query_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ctrl-hub.com/v3/queries/{query_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'queries',
'attributes' => [
'name' => '<string>',
'description' => '<string>',
'fields' => [
[
'key' => '<string>',
'label' => '<string>',
'type' => '<string>',
'decimals' => 5,
'resolution' => [
'projections' => [
[
'path' => [
'<string>'
],
'attribute' => '<string>',
'label' => '<string>'
]
]
]
]
],
'group_by' => [
[
'key' => '<string>',
'label' => '<string>',
'type' => '<string>',
'bin' => [
'from' => 123,
'width' => 123,
'to' => 123,
'thresholds' => [
123
]
]
]
],
'measures' => [
[
'key' => '<string>',
'type' => '<string>',
'percentile' => 50,
'decimals' => 5,
'label' => '<string>'
]
],
'filters' => [
[
'key' => '<string>',
'op' => '<string>',
'values' => [
'<string>'
]
]
],
'sort' => [
[
'key' => '<string>'
]
],
'column_order' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ctrl-hub.com/v3/queries/{query_id}"
payload := strings.NewReader("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"queries\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"decimals\": 5,\n \"resolution\": {\n \"projections\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"attribute\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"group_by\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"bin\": {\n \"from\": 123,\n \"width\": 123,\n \"to\": 123,\n \"thresholds\": [\n 123\n ]\n }\n }\n ],\n \"measures\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"percentile\": 50,\n \"decimals\": 5,\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"op\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"sort\": [\n {\n \"key\": \"<string>\"\n }\n ],\n \"column_order\": [\n \"<string>\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ctrl-hub.com/v3/queries/{query_id}")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"queries\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"decimals\": 5,\n \"resolution\": {\n \"projections\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"attribute\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"group_by\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"bin\": {\n \"from\": 123,\n \"width\": 123,\n \"to\": 123,\n \"thresholds\": [\n 123\n ]\n }\n }\n ],\n \"measures\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"percentile\": 50,\n \"decimals\": 5,\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"op\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"sort\": [\n {\n \"key\": \"<string>\"\n }\n ],\n \"column_order\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/queries/{query_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"queries\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"decimals\": 5,\n \"resolution\": {\n \"projections\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"attribute\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"group_by\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"type\": \"<string>\",\n \"bin\": {\n \"from\": 123,\n \"width\": 123,\n \"to\": 123,\n \"thresholds\": [\n 123\n ]\n }\n }\n ],\n \"measures\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"percentile\": 50,\n \"decimals\": 5,\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"key\": \"<string>\",\n \"op\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"sort\": [\n {\n \"key\": \"<string>\"\n }\n ],\n \"column_order\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "queries",
"attributes": {
"name": "<string>",
"dataset": "form-submissions",
"mode": "detail",
"description": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"decimals": 5,
"resolution": {
"projections": [
{
"path": [
"<string>"
],
"attribute": "<string>",
"label": "<string>",
"multi_value": "join"
}
]
}
}
],
"group_by": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"bucket": "day",
"bin": {
"from": 123,
"width": 123,
"to": 123,
"thresholds": [
123
]
}
}
],
"measures": [
{
"func": "count",
"key": "<string>",
"type": "<string>",
"percentile": 50,
"decimals": 5,
"label": "<string>"
}
],
"filters": [
{
"key": "<string>",
"op": "<string>",
"values": [
"<string>"
]
}
],
"sort": [
{
"key": "<string>",
"direction": "asc"
}
],
"column_order": [
"<string>"
]
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"form": {
"data": {
"type": "forms",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
},
"jsonapi": {
"version": "1.0"
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations",
"attributes": {
"name": "Acme Construction Ltd",
"slug": "acme-construction",
"sandbox": false,
"description": "Leading construction company specializing in infrastructure projects",
"settings": {
"teams": {
"customer_representatives": [
"b234c567-8901-2345-6789-abcdef012345"
]
}
}
},
"meta": {
"v3": true,
"status": "active",
"created_at": "2023-01-15T10:30:00.000Z",
"updated_at": "2023-02-20T14:45:00.000Z",
"features": [
{
"name": "advanced_reporting",
"enabled": true,
"limit": 1000
}
]
},
"relationships": {
"users": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
]
},
"service_accounts": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "service-accounts"
}
]
},
"groups": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "groups"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "teams"
}
]
},
"nomenclature": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "nomenclature"
}
}
}
}
]
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f",
"status": "404",
"title": "Resource not found",
"detail": "The requested resource could not be found or does not exist.",
"code": "NOT_FOUND.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
SessionCookieOAuth2
Session token for authentication.
Path Parameters
The unique identifier for the query.
Body
application/vnd.api+json
The query fields to update. Partial; only supplied attributes change.
Show child attributes
Show child attributes