Skip to main content
GET
/
v2
/
queries
Get accessible queries
curl --request GET \
  --url https://api-dev.narrative.io/v2/queries \
  --header 'Authorization: Bearer <token>'
{
  "prev_page": null,
  "current_page": 1,
  "next_page": null,
  "total_records": 1,
  "total_pages": 1,
  "records": [
    {
      "name": "query1",
      "id": "7409b999-2a9a-40cd-89dc-8430d85e0391",
      "display_name": "Query One",
      "owner": {
        "company_id": 456,
        "company_name": "ExampleCorp",
        "company_slug": "examplecorp"
      },
      "tags": [
        "tag1",
        "tag2"
      ],
      "collaborators": {
        "query": {
          "type": "inclusion",
          "company_ids": [
            789
          ]
        },
        "view": {
          "type": "all"
        }
      },
      "is_owned": true,
      "metadata": {
        "created_at": "2024-04-12T19:57:05.012908",
        "created_by_user_id": 321,
        "updated_at": "2024-04-12T20:03:48.031825",
        "updated_by_user_id": 321
      },
      "ast": {
        "type": "select",
        "nql": "SELECT age FROM narrative.rosetta_stone",
        "budget": null,
        "columns": [
          {
            "type": "table",
            "nql": "age",
            "db": null,
            "schema": null,
            "table": "age"
          }
        ],
        "from": {
          "type": "table",
          "nql": "narrative.rosetta_stone",
          "db": null,
          "schema": "narrative",
          "table": "rosetta_stone"
        },
        "group_by": [],
        "having": null,
        "is_distinct": false,
        "limit": null,
        "order_by": [],
        "qualify": null,
        "where": null,
        "windows": [],
        "with": []
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
is_owned
boolean

If true returns only queries that are owned by the requestor. If false returns only queries that have been shared with the requestor. If not provided returns both.

​
tag
string

Filters queries that are tagged with tag. Can appear multiple times, in which case they're OR-d together

​
page
integer

Number of page. Stars from the first (1) page.

​
per_page
integer

Number of records to return.

Response

200 - application/json

OK

​
records
object[]
required
Example:
{
  "name": "query1",
  "id": "7409b999-2a9a-40cd-89dc-8430d85e0391",
  "display_name": "Query One",
  "owner": {
    "company_id": 456,
    "company_name": "ExampleCorp",
    "company_slug": "examplecorp"
  },
  "tags": ["tag1", "tag2"],
  "collaborators": {
    "query": { "type": "inclusion", "company_ids": [789] },
    "view": { "type": "all" }
  },
  "is_owned": true,
  "metadata": {
    "created_at": "2024-04-12T19:57:05.012908",
    "created_by_user_id": 321,
    "updated_at": "2024-04-12T20:03:48.031825",
    "updated_by_user_id": 321
  },
  "ast": {
    "type": "select",
    "nql": "SELECT age FROM narrative.rosetta_stone",
    "budget": null,
    "columns": [
      {
        "type": "table",
        "nql": "age",
        "db": null,
        "schema": null,
        "table": "age"
      }
    ],
    "from": {
      "type": "table",
      "nql": "narrative.rosetta_stone",
      "db": null,
      "schema": "narrative",
      "table": "rosetta_stone"
    },
    "group_by": [],
    "having": null,
    "is_distinct": false,
    "limit": null,
    "order_by": [],
    "qualify": null,
    "where": null,
    "windows": [],
    "with": []
  }
}
​
prev_page
integer<int64>

The number of previous page (if exists). Also can refer to the latest existing page if non-existing page was requested.

Example:

1

​
current_page
integer<int64>

The number of requested page.

Example:

1

​
next_page
integer<int64>

The number of next page (if exists).

Example:

42

​
total_records
integer<int64>

Total amount of accessible Access Rules

Example:

15000

​
total_pages
integer<int64>

Total amount of pages.

Example:

10