ReferenceSearches
ResourcesSearches

Searches

List searches

GET
/api/v1/orgs/{owner}/searches

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/searches"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "user": "string",      "project": "string",      "tags": [        "string"      ],      "live_state": 0,      "spec": {        "query": "string",        "sort": "string",        "limit": 0,        "offset": 0,        "groupby": "string",        "columns": "string",        "layout": "string",        "sections": "string",        "compares": "string",        "heat": "string",        "events": {          "sections": [            {              "name": "string",              "is_minimized": true,              "is_frozen": true,              "columns": 0,              "height": 0,              "xaxis": "string",              "smoothing": 0,              "step": 0,              "ignore_outliers": true,              "sample_size": 0,              "widgets": [                {}              ],              "page_index": 0,              "page_size": 0            }          ],          "xaxis": "string",          "smoothing": 0,          "step": 0,          "ignore_outliers": true,          "sample_size": 0        },        "histograms": {},        "trends": {},        "analytics": {          "view": "string",          "trunc": "string",          "groupby": "string",          "frequency": "string"        }      },      "level": "entity",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
POST
/api/v1/orgs/{owner}/searches

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Search body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/searches" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "project": "string",  "tags": [    "string"  ],  "live_state": 0,  "spec": {    "query": "string",    "sort": "string",    "limit": 0,    "offset": 0,    "groupby": "string",    "columns": "string",    "layout": "string",    "sections": "string",    "compares": "string",    "heat": "string",    "events": {      "sections": [        {          "name": "string",          "is_minimized": true,          "is_frozen": true,          "columns": 0,          "height": 0,          "xaxis": "string",          "smoothing": 0,          "step": 0,          "ignore_outliers": true,          "sample_size": 0,          "widgets": [            {}          ],          "page_index": 0,          "page_size": 0        }      ],      "xaxis": "string",      "smoothing": 0,      "step": 0,      "ignore_outliers": true,      "sample_size": 0    },    "histograms": {},    "trends": {},    "analytics": {      "view": "string",      "trunc": "string",      "groupby": "string",      "frequency": "string"    }  },  "level": "entity",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List search names

GET
/api/v1/orgs/{owner}/searches/names

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/searches/names"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "user": "string",      "project": "string",      "tags": [        "string"      ],      "live_state": 0,      "spec": {        "query": "string",        "sort": "string",        "limit": 0,        "offset": 0,        "groupby": "string",        "columns": "string",        "layout": "string",        "sections": "string",        "compares": "string",        "heat": "string",        "events": {          "sections": [            {              "name": "string",              "is_minimized": true,              "is_frozen": true,              "columns": 0,              "height": 0,              "xaxis": "string",              "smoothing": 0,              "step": 0,              "ignore_outliers": true,              "sample_size": 0,              "widgets": [                {}              ],              "page_index": 0,              "page_size": 0            }          ],          "xaxis": "string",          "smoothing": 0,          "step": 0,          "ignore_outliers": true,          "sample_size": 0        },        "histograms": {},        "trends": {},        "analytics": {          "view": "string",          "trunc": "string",          "groupby": "string",          "frequency": "string"        }      },      "level": "entity",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
PATCH
/api/v1/orgs/{owner}/searches/{search.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

search.uuid*string

UUID

Request Body

application/json

Search body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/searches/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "project": "string",  "tags": [    "string"  ],  "live_state": 0,  "spec": {    "query": "string",    "sort": "string",    "limit": 0,    "offset": 0,    "groupby": "string",    "columns": "string",    "layout": "string",    "sections": "string",    "compares": "string",    "heat": "string",    "events": {      "sections": [        {          "name": "string",          "is_minimized": true,          "is_frozen": true,          "columns": 0,          "height": 0,          "xaxis": "string",          "smoothing": 0,          "step": 0,          "ignore_outliers": true,          "sample_size": 0,          "widgets": [            {}          ],          "page_index": 0,          "page_size": 0        }      ],      "xaxis": "string",      "smoothing": 0,      "step": 0,      "ignore_outliers": true,      "sample_size": 0    },    "histograms": {},    "trends": {},    "analytics": {      "view": "string",      "trunc": "string",      "groupby": "string",      "frequency": "string"    }  },  "level": "entity",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
PUT
/api/v1/orgs/{owner}/searches/{search.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

search.uuid*string

UUID

Request Body

application/json

Search body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/searches/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "project": "string",  "tags": [    "string"  ],  "live_state": 0,  "spec": {    "query": "string",    "sort": "string",    "limit": 0,    "offset": 0,    "groupby": "string",    "columns": "string",    "layout": "string",    "sections": "string",    "compares": "string",    "heat": "string",    "events": {      "sections": [        {          "name": "string",          "is_minimized": true,          "is_frozen": true,          "columns": 0,          "height": 0,          "xaxis": "string",          "smoothing": 0,          "step": 0,          "ignore_outliers": true,          "sample_size": 0,          "widgets": [            {}          ],          "page_index": 0,          "page_size": 0        }      ],      "xaxis": "string",      "smoothing": 0,      "step": 0,      "ignore_outliers": true,      "sample_size": 0    },    "histograms": {},    "trends": {},    "analytics": {      "view": "string",      "trunc": "string",      "groupby": "string",      "frequency": "string"    }  },  "level": "entity",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
GET
/api/v1/orgs/{owner}/searches/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/searches/string"
{  "uuid": "string",  "name": "string",  "description": "string",  "user": "string",  "project": "string",  "tags": [    "string"  ],  "live_state": 0,  "spec": {    "query": "string",    "sort": "string",    "limit": 0,    "offset": 0,    "groupby": "string",    "columns": "string",    "layout": "string",    "sections": "string",    "compares": "string",    "heat": "string",    "events": {      "sections": [        {          "name": "string",          "is_minimized": true,          "is_frozen": true,          "columns": 0,          "height": 0,          "xaxis": "string",          "smoothing": 0,          "step": 0,          "ignore_outliers": true,          "sample_size": 0,          "widgets": [            {}          ],          "page_index": 0,          "page_size": 0        }      ],      "xaxis": "string",      "smoothing": 0,      "step": 0,      "ignore_outliers": true,      "sample_size": 0    },    "histograms": {},    "trends": {},    "analytics": {      "view": "string",      "trunc": "string",      "groupby": "string",      "frequency": "string"    }  },  "level": "entity",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
DELETE
/api/v1/orgs/{owner}/searches/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/searches/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Service Accounts
Tags

On this page

List searchesCreate searchList search namesPatch searchUpdate searchGet searchDelete search

Actions

Give us feedback