Saved Search

Returns all saved search charts that the user has access to

Get a list of SavedSearchCharts.

GET/api/1.0/saved-searches/{saved_search_id}/charts

Query parameters

Response

200

list of saved search charts

Body

application/json

dataarray of SavedSearchChart (all of)

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{saved_search_id}/charts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "saved_search_id": "text",
      "user_id": "text",
      "created_at": "2024-05-11T06:55:22.501Z",
      "updated_at": "2024-05-11T06:55:22.501Z",
      "deleted_at": "2024-05-11T06:55:22.501Z",
      "title": "text",
      "type": "bar"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new saved search chart

Create a new SavedSearchChart.

POST/api/1.0/saved-searches/{saved_search_id}/charts

Path parameters

saved_search_id*string

ID of saved search to which this chart will be saved

Body

application/json

titlestring

Represents an Eloquent model of a Saved Search Chart.

typeenum

barbar-verticallinepiedoughnut

configobject

sortinteger

Response

201

success

Body

application/json

idstring (id)

saved_search_idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

titlestring

Represents an Eloquent model of a Saved Search Chart.

typeenum

barbar-verticallinepiedoughnut

configobject

sortinteger

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{saved_search_id}/charts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "deleted_at": "2024-05-11T06:55:22.501Z",
  "title": "text",
  "type": "bar"
}

Update several saved search charts at once

Batch update several SavedSearchCharts.

PUT/api/1.0/saved-searches/{saved_search_id}/charts

Path parameters

saved_search_id*string

ID of saved search to which these charts will be saved

Body

application/json

idstring (id)

saved_search_idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

titlestring

Represents an Eloquent model of a Saved Search Chart.

typeenum

barbar-verticallinepiedoughnut

configobject

sortinteger

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{saved_search_id}/charts', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Get single saved search chart by ID

Get a single SavedSearchChart.

GET/api/1.0/saved-searches/charts/{chart_id}

Path parameters

chart_id*string

ID of chart to return

Response

200

Successfully found the saved search chart

Body

application/json

idstring (id)

saved_search_idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

titlestring

Represents an Eloquent model of a Saved Search Chart.

typeenum

barbar-verticallinepiedoughnut

configobject

sortinteger

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/charts/{chart_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "deleted_at": "2024-05-11T06:55:22.501Z",
  "title": "text",
  "type": "bar"
}

Update a saved search chart

Update a SavedSearchChart.

PUT/api/1.0/saved-searches/charts/{chart_id}

Path parameters

chart_id*string

ID of chart to return

Body

application/json

titlestring

Represents an Eloquent model of a Saved Search Chart.

typeenum

barbar-verticallinepiedoughnut

configobject

sortinteger

Response

200

success

Body

application/json

idstring (id)

saved_search_idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

titlestring

Represents an Eloquent model of a Saved Search Chart.

typeenum

barbar-verticallinepiedoughnut

configobject

sortinteger

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/charts/{chart_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "deleted_at": "2024-05-11T06:55:22.501Z",
  "title": "text",
  "type": "bar"
}

Delete a saved search chart

Delete a SavedSearchChart.

DELETE/api/1.0/saved-searches/charts/{chart_id}

Path parameters

chart_id*string

ID of chart to return

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/charts/{chart_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get available chart fields for a Saved Search by ID

Get available chart fields for a Saved Search.

GET/api/1.0/saved-searches/charts/{chart_id}/fields

Path parameters

chart_id*string

ID of Saved Search to return

Response

200

Successfully found the saved search

Body

application/json

idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/charts/{chart_id}/fields', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Save a new report

POST/api/1.0/saved-searches/reports

Body

application/json

typeenum

adhocscheduled

formatenum

csvxlsx

saved_search_idinteger

configobject

toarray of string

subjectstring

bodystring

Response

201

success

Body

application/json

idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/reports', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Update a saved search

Update a Report

PUT/api/1.0/saved-searches/reports/{reportId}

Path parameters

reportId*string

ID of report

Body

application/json

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Response

200

success

Body

application/json

idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/reports/{reportId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Returns all saved searches that the user has access to

Get a list of SavedSearches.

GET/api/1.0/saved-searches

Query parameters

Response

200

list of saved searches

Body

application/json

dataarray of SavedSearch (all of)

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "user_id": "text",
      "created_at": "2024-05-11T06:55:22.501Z",
      "updated_at": "2024-05-11T06:55:22.501Z",
      "pmql": "text",
      "title": "text",
      "type": "task"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new saved search

Create a new SavedSearch.

POST/api/1.0/saved-searches

Body

application/json

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Response

201

success

Body

application/json

idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Get single saved searches by ID

Get a single SavedSearch.

GET/api/1.0/saved-searches/{savedSearchId}

Path parameters

savedSearchId*string

ID of saved search to return

Response

200

Successfully found the saved search

Body

application/json

idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{savedSearchId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Update a saved search

Update a SavedSearch.

PUT/api/1.0/saved-searches/{savedSearchId}

Path parameters

savedSearchId*string

ID of saved search to return

Body

application/json

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Response

200

success

Body

application/json

idstring (id)

user_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typeenum

taskrequest

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{savedSearchId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": "text",
  "created_at": "2024-05-11T06:55:22.501Z",
  "updated_at": "2024-05-11T06:55:22.501Z",
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Returns all columns associated with a Saved Search

Display a listing of columns.

GET/api/1.0/saved-searches/{savedSearchId}/columns

Path parameters

savedSearchId*string

ID of saved search to return

Query parameters

Response

200

Categorized list of columns

Body

application/json

currentarray of columns (object)

defaultarray of columns (object)

availablearray of columns (object)

dataarray of columns (object)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{savedSearchId}/columns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "current": [
    {
      "label": "text",
      "field": "text",
      "sortable": false,
      "default": false,
      "format": "text",
      "mask": "text"
    }
  ],
  "default": [
    {
      "label": "text",
      "field": "text",
      "sortable": false,
      "default": false,
      "format": "text",
      "mask": "text"
    }
  ],
  "available": [
    {
      "label": "text",
      "field": "text",
      "sortable": false,
      "default": false,
      "format": "text",
      "mask": "text"
    }
  ],
  "data": [
    {
      "label": "text",
      "field": "text",
      "sortable": false,
      "default": false,
      "format": "text",
      "mask": "text"
    }
  ]
}

Returns all users

Display a listing of the resource.

GET/api/1.0/saved-searches/{savedSearchId}/users

Path parameters

savedSearchId*string

ID of saved search to return

Query parameters

Response

200

list of users

Body

application/json

dataarray of users (all of)

metametadata (object)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{savedSearchId}/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "email": "[e-mail]",
      "firstname": "text",
      "lastname": "text",
      "username": "text",
      "password": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phone": "text",
      "fax": "text",
      "cell": "text",
      "title": "text",
      "timezone": "text",
      "datetime_format": "text",
      "language": "text",
      "is_administrator": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "created_at": "2024-05-11T06:55:22.501Z",
          "updated_at": "2024-05-11T06:55:22.501Z"
        }
      ],
      "birthdate": "2024-05-11",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "created_at": "2024-05-11T06:55:22.501Z",
      "updated_at": "2024-05-11T06:55:22.501Z",
      "deleted_at": "2024-05-11T06:55:22.501Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Returns all groups that the user has access to

Display a listing of the resource.

GET/api/1.0/saved-searches/{savedSearchId}/groups

Query parameters

Response

200

list of groups

Body

application/json

dataarray of groups (all of)

metametadata (object)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{savedSearchId}/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "created_at": "2024-05-11T06:55:22.501Z",
      "updated_at": "2024-05-11T06:55:22.501Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Delete a saved search

Delete a SavedSearch.

DELETE/api/1.0/saved-searches/{saved_search_id}

Path parameters

saved_search_id*string

ID of saved search to return

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/{saved_search_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Returns all icons for saved searches

Get a list of icons available for SavedSearches.

GET/api/1.0/saved-searches/icons

Query parameters

Response

200

list of icons for saved searches

Body

application/json

dataarray of SavedSearchIcon (object)

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/1.0/saved-searches/icons', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}