List all saved queries

GET /apl-starred-queries

cURL

cURL

curl --request GET \
  --url https://api.axiom.co/v2/apl-starred-queries \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.axiom.co/v2/apl-starred-queries"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.axiom.co/v2/apl-starred-queries', 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.axiom.co/v2/apl-starred-queries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axiom.co/v2/apl-starred-queries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.axiom.co/v2/apl-starred-queries")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axiom.co/v2/apl-starred-queries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "kind": "apl",
    "metadata": {},
    "name": "<string>",
    "query": {
      "apl": "<string>",
      "cursor": "<string>",
      "defaultLimit": 123,
      "defaultOrder": [
        {
          "desc": true,
          "field": "<string>"
        }
      ],
      "endTime": "<string>",
      "includeCursor": true,
      "includeCursorField": true,
      "libraries": [
        "<string>"
      ],
      "queryOptions": {
        "disableCache": true,
        "disableStats": true,
        "disableTrace": true,
        "maxDataPoints": 123,
        "maxSeries": 123,
        "noAggregation": true,
        "noFill": true,
        "noInterpolation": true,
        "resolution": "<string>"
      },
      "startTime": "<string>",
      "variables": {}
    },
    "who": "<string>",
    "id": "<string>",
    "dataset": "<string>"
  }
]

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit · integer<int64> · default: 100

Required range: 1 <= x <= 1000

offset · integer<int64> · default: 0

Required range: x >= 0

dataset · string

who · string

• If the value of who is undefined, the request returns queries starred by the authenticated user.
• If the value of who is a user ID, the request returns queries starred by the user with this ID (this request requires elevated privileges). For example, &who='abc123'.
• If the value of who is team, the request returns queries starred by the team apart from the authenticated user.For example, &who=team.
• If the value of who is all, the request returns queries starred by all users in the team, including the authenticated user. For example, &who=all.

qs · string

Response

200 - application/json

StarredQueryWithId

kind · enum<string> · required

Available options: apl

metadata · object · required

Show child attributes

name · string · required

query · object · required

Show child attributes

who · string · required

id · string · required

dataset · string