Saved Search

Returns all saved search charts that the user has access to

get

Get a list of SavedSearchCharts.

Authorizations

passportbearer

Query parameters

filterstringoptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

typestring · enumoptional

Only return saved searches by type

Options: request, task, collection

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts'

200

200

{
  "data": [
    {
      "id": "text",
      "saved_search_id": "text",
      "user_id": "text",
      "created_at": "2025-03-28T00:29:43.023Z",
      "updated_at": "2025-03-28T00:29:43.023Z",
      "deleted_at": "2025-03-28T00:29:43.023Z",
      "title": "text",
      "type": "bar",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "sort": 1
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of saved search charts

Save a new saved search chart

post

Create a new SavedSearchChart.

Authorizations

passportbearer

Path parameters

saved_search_idstringrequired

ID of saved search to which this chart will be saved

Body

titlestringoptional

Represents an Eloquent model of a Saved Search Chart.

typestring · enumoptional

Options: bar, bar-vertical, line, pie, doughnut

configobjectoptional

sortintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "bar",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "sort": 1
  }'

201

201

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "deleted_at": "2025-03-28T00:29:43.023Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

success

Update several saved search charts at once

put

Batch update several SavedSearchCharts.

Authorizations

passportbearer

Path parameters

saved_search_idstringrequired

ID of saved search to which these charts will be saved

Body

itemsall ofoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "id": "text",
      "saved_search_id": "text",
      "user_id": "text",
      "created_at": "2025-03-28T00:29:43.023Z",
      "updated_at": "2025-03-28T00:29:43.023Z",
      "deleted_at": "2025-03-28T00:29:43.023Z",
      "title": "text",
      "type": "bar",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "sort": 1
    }
  ]'

204

204

No body

success

Get single saved search chart by ID

get

Get a single SavedSearchChart.

Authorizations

passportbearer

Path parameters

chart_idstringrequired

ID of chart to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/charts/{chart_id}'

200

200

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "deleted_at": "2025-03-28T00:29:43.023Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

Successfully found the saved search chart

Update a saved search chart

put

Update a SavedSearchChart.

Authorizations

passportbearer

Path parameters

chart_idstringrequired

ID of chart to return

Body

titlestringoptional

Represents an Eloquent model of a Saved Search Chart.

typestring · enumoptional

Options: bar, bar-vertical, line, pie, doughnut

configobjectoptional

sortintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/charts/{chart_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "bar",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "sort": 1
  }'

200

200

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "deleted_at": "2025-03-28T00:29:43.023Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

success

Delete a saved search chart

delete

Delete a SavedSearchChart.

Authorizations

passportbearer

Path parameters

chart_idstringrequired

ID of chart to return

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/saved-searches/charts/{chart_id}'

204

204

No body

success

Get available chart fields for a Saved Search by ID

get

Get available chart fields for a Saved Search.

Authorizations

passportbearer

Path parameters

chart_idstringrequired

ID of Saved Search to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/charts/{chart_id}/fields'

200

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Successfully found the saved search

Save a new report

post

Authorizations

passportbearer

Body

typestring · enumoptional

Options: adhoc, scheduled

formatstring · enumoptional

Options: csv, xlsx

saved_search_idintegeroptional

configobjectoptional

tostring[]optional

subjectstringoptional

bodystringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches/reports' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "adhoc",
    "format": "csv",
    "saved_search_id": 1,
    "config": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "to": [
      "text"
    ],
    "subject": "text",
    "body": "text"
  }'

201

201

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Update a saved search

put

Update a Report

Authorizations

passportbearer

Path parameters

reportIdstringrequired

ID of report

Body

metaobjectoptional

Represents an Eloquent model of a Saved Search.

pmqlstringoptional

titlestringoptional

typestring · enumoptional

Options: task, request

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/reports/{reportId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "pmql": "text",
    "title": "text",
    "type": "task"
  }'

200

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Returns all saved searches that the user has access to

get

Get a list of SavedSearches.

Authorizations

passportbearer

Query parameters

filterstringoptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

typestring · enumoptional

Only return saved searches by type

Options: request, task, collection

subsetstring · enumoptional

Only return saved searches that are yours or those that have been shared with you

Options: mine, shared

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches'

200

200

{
  "data": [
    {
      "id": "text",
      "user_id": "text",
      "created_at": "2025-03-28T00:29:43.023Z",
      "updated_at": "2025-03-28T00:29:43.023Z",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "pmql": "text",
      "title": "text",
      "type": "task"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of saved searches

Save a new saved search

post

Create a new SavedSearch.

Authorizations

passportbearer

Body

metaobjectoptional

Represents an Eloquent model of a Saved Search.

pmqlstringoptional

titlestringoptional

typestring · enumoptional

Options: task, request

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches' \
  --header 'Content-Type: application/json' \
  --data '{
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "pmql": "text",
    "title": "text",
    "type": "task"
  }'

201

201

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Get single saved searches by ID

get

Get a single SavedSearch.

Authorizations

passportbearer

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}'

200

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Successfully found the saved search

Update a saved search

put

Update a SavedSearch.

Authorizations

passportbearer

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Body

metaobjectoptional

Represents an Eloquent model of a Saved Search.

pmqlstringoptional

titlestringoptional

typestring · enumoptional

Options: task, request

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/{savedSearchId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "pmql": "text",
    "title": "text",
    "type": "task"
  }'

200

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-03-28T00:29:43.023Z",
  "updated_at": "2025-03-28T00:29:43.023Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Returns all columns associated with a Saved Search

get

Display a listing of columns.

Authorizations

passportbearer

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Query parameters

includestring · enum[]optional

Include specific categories. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}/columns'

200

200

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

Categorized list of columns

Returns all users

get

Display a listing of the resource.

Authorizations

passportbearer

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Query parameters

filterstringoptional

Filter results by string. Searches First Name, Last Name, Email and Username.

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}/users'

200

200

{
  "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": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 1,
          "model_id": 1,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 1,
          "manipulations": {},
          "custom_properties": {},
          "responsive_images": {},
          "order_column": 1,
          "created_at": "2025-03-28T00:29:43.023Z",
          "updated_at": "2025-03-28T00:29:43.023Z"
        }
      ],
      "birthdate": "2025-03-28",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-03-28T00:29:43.023Z",
      "updated_at": "2025-03-28T00:29:43.023Z",
      "deleted_at": "2025-03-28T00:29:43.023Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of users

Returns all groups that the user has access to

get

Display a listing of the resource.

Authorizations

passportbearer

Query parameters

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}/groups'

200

200

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 1,
      "status": "ACTIVE",
      "created_at": "2025-03-28T00:29:43.023Z",
      "updated_at": "2025-03-28T00:29:43.023Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of groups

Delete a saved search

delete

Delete a SavedSearch.

Authorizations

passportbearer

Path parameters

saved_search_idstringrequired

ID of saved search to return

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/saved-searches/{saved_search_id}'

204

204

No body

success

Returns all icons for saved searches

get

Get a list of icons available for SavedSearches.

Authorizations

passportbearer

Query parameters

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/saved-searches/icons'

200

200

{
  "data": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of icons for saved searches