Analytics

Queries

`Query` collection response

Queries

array

Query Object

id

integer

token

string

name

string

raw_query

string

creator_email

string

data_source_token

string

report_id

string

report_token

string

space_id

string

space_token

string

Links

Paginated resources will contain a set of links to the previous page and next page of results.

  • next_page
  • prev_page

Pagination

page

integer

per_page

integer

count

integer

total_pages

integer

total_count

integer

{
    "pagination": {
        "page": 1,
        "per_page": 1000,
        "count": 1000,
        "total_pages": 5,
        "total_count": 4146
    },
    "queries": [
        {
            "id": 3022,
            "token": "25e6637df704",
            "name": "Ut qui",
            "raw_query": "\n      SELECT DISTINCT code, name\n        FROM states\n\n      {% form %}\n        state:\n          type: select\n          default: 'GA'\n          options:\n            values: code\n            labels: name\n      {% endform %}\n    ",
            "creator_email": "creator@company.com",
            "data_source_token": "022d5cba6ff0",
            "report_id": 10850,
            "report_token": "602797d3122f",
            "space_id": 102,
            "space_token": "1970811fa289"
        },
        {
            "id": 3005,
            "token": "bfe4fc361d9f",
            "name": "Aspernatur",
            "raw_query": "\n      SELECT DISTINCT code, name\n        FROM states\n\n      {% form %}\n        state:\n          type: select\n          default: 'GA'\n          options:\n            values: code\n            labels: name\n      {% endform %}\n    ",
            "creator_email": "creator@company.com",
            "data_source_token": "022d5cba6ff0",
            "report_id": 10833,
            "report_token": "712489649deb",
            "space_id": 102,
            "space_token": "1970811fa289"
        },
        {
            "id": 3014,
            "token": "728f6328ea67",
            "name": "Et sint",
            "raw_query": "\n      SELECT DISTINCT code, name\n        FROM states\n\n      {% form %}\n        state:\n          type: select\n          default: 'GA'\n          options:\n            values: code\n            labels: name\n      {% endform %}\n    ",
            "creator_email": "creator@company.com",
            "data_source_token": "022d5cba6ff0",
            "report_id": 10842,
            "report_token": "08922fac4d74",
            "space_id": 102,
            "space_token": "1970811fa289"
        },
        ...
    ],
    "_links": {
        "next_page": {
            "href": "/batch/{workspace}/queries?page=2&per_page=1000"
        },
        "prev_page": {
            "href": "/batch/{workspace}/queries?page=1&per_page=1000"
        }
    }
}

List queries for an account

To return a paginated list of all queries for a given Workspace, send a GET request. Each page has 1000 queries by default.

URL Params

workspace

required
string Workspace username
Query Params

include_spaces

string With?include_spaces=all, the endpoint will include Queries in members' personal spaces. By default Queries in members personal spaces are excluded.

per_page

integer The number of objects to return per_page. Example: per_page?=100. Note: per_page must be greater than 0 and less than 1000.
Responses

200

Query collection response

401

Unauthorized

404

Workspace not found

GET /batch/{workspace}/queries

curl --location --request GET 'https://app.mode.com/batch/{workspace}/queries' \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --header "Authorization: {bearer_token}"

# Optional Query Params
  # ?include_spaces=all will include queries in members' personal spaces

curl --location --request GET 'https://app.mode.com/batch/{workspace}/queries?include_spaces=all' \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: {bearer_token}"
require 'http'

decoded_token = "#{token}:#{access_key}:#{access_secret}"
encoded_token = Base64.strict_encode64(decoded_token)
bearer_token  = "Bearer #{encoded_token}"

headers = {
  content_type: 'application/json',
  accept: 'application/json',
  authorization: bearer_token
}

response = HTTP.headers(headers)
               .get('https://app.mode.com/batch/{workspace}/queries')
puts response

# Optional Query Params
  # ?include_spaces=all will include queries in members' personal spaces

response = HTTP.headers(headers)
              .get('https://app.mode.com/batch/{workspace}/queries?include_spaces=all')
from urllib2 import Request, urlopen
from base64 import b64encode

decoded_token = token + ':' + access_key + ':' + access_secret
encoded_token = b64encode(decoded_token.encode('utf-8'))
bearer_token  = 'Bearer ' + encoded_token.decode('utf-8')

request = Request("https://app.mode.com/batch/{workspace}/queries")

request.add_header("Authorization", bearer_token)
request.add_header("Accept", "application/json")
request.add_header("Content-Type", "application/json")

response = urlopen(request)
response_body = response.read()

print(response_body)

# Optional Query Params
  # ?include_spaces=all will include queries in members' personal spaces

request = Request("https://app.mode.com/batch/{workspace}/queries?include_spaces=all")
var request = new XMLHttpRequest();

var decoded_token = token + ':' + access_key + ':' + access_secret;
var encoded_token = btoa(decoded_token);
var bearer_token  = 'Bearer ' + encoded_token;

request.open('GET', 'https://app.mode.com/batch/{workspace}/queries');
request.withCredentials = true;

request.setRequestHeader('Authorization', bearer_token);
request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('Accept', 'application/json');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();

// Optional Query Params
  // ?include_spaces=all will include queries in members' personal spaces

request.open('GET', 'https://app.mode.com/batch/{workspace}/queries?include_spaces=all');