Saved Search
Get a list of SavedSearchCharts.
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Only return saved searches by type
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/saved-searches/{saved_search_id}/charts HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of saved search charts
{
"data": [
{
"id": "text",
"saved_search_id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"deleted_at": "2025-07-05T04:25:52.647Z",
"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
}
}
Create a new SavedSearchChart.
ID of saved search to which this chart will be saved
Represents an Eloquent model of a Saved Search Chart.
POST /api/1.0/saved-searches/{saved_search_id}/charts HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"title": "text",
"type": "bar",
"config": {
"ANY_ADDITIONAL_PROPERTY": null
},
"sort": 1
}
success
{
"id": "text",
"saved_search_id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"deleted_at": "2025-07-05T04:25:52.647Z",
"title": "text",
"type": "bar",
"config": {
"ANY_ADDITIONAL_PROPERTY": null
},
"sort": 1
}
Batch update several SavedSearchCharts.
ID of saved search to which these charts will be saved
PUT /api/1.0/saved-searches/{saved_search_id}/charts HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 256
[
{
"id": "text",
"saved_search_id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"deleted_at": "2025-07-05T04:25:52.647Z",
"title": "text",
"type": "bar",
"config": {
"ANY_ADDITIONAL_PROPERTY": null
},
"sort": 1
}
]
success
No content
Get a single SavedSearchChart.
ID of chart to return
GET /api/1.0/saved-searches/charts/{chart_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the saved search chart
{
"id": "text",
"saved_search_id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"deleted_at": "2025-07-05T04:25:52.647Z",
"title": "text",
"type": "bar",
"config": {
"ANY_ADDITIONAL_PROPERTY": null
},
"sort": 1
}
Update a SavedSearchChart.
ID of chart to return
Represents an Eloquent model of a Saved Search Chart.
PUT /api/1.0/saved-searches/charts/{chart_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"title": "text",
"type": "bar",
"config": {
"ANY_ADDITIONAL_PROPERTY": null
},
"sort": 1
}
success
{
"id": "text",
"saved_search_id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"deleted_at": "2025-07-05T04:25:52.647Z",
"title": "text",
"type": "bar",
"config": {
"ANY_ADDITIONAL_PROPERTY": null
},
"sort": 1
}
Get available chart fields for a Saved Search.
ID of Saved Search to return
GET /api/1.0/saved-searches/charts/{chart_id}/fields HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the saved search
{
"id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
POST /api/1.0/saved-searches/reports HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"type": "adhoc",
"format": "csv",
"saved_search_id": 1,
"config": {
"ANY_ADDITIONAL_PROPERTY": null
},
"to": [
"text"
],
"subject": "text",
"body": "text"
}
success
{
"id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
Update a Report
ID of report
PUT /api/1.0/saved-searches/reports/{reportId} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
success
{
"id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
Get a list of SavedSearches.
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Only return saved searches by type
Only return saved searches that are yours or those that have been shared with you
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/saved-searches HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of saved searches
{
"data": [
{
"id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"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
}
}
Create a new SavedSearch.
POST /api/1.0/saved-searches HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
success
{
"id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
Get a single SavedSearch.
ID of saved search to return
GET /api/1.0/saved-searches/{savedSearchId} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the saved search
{
"id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
Update a SavedSearch.
ID of saved search to return
PUT /api/1.0/saved-searches/{savedSearchId} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
success
{
"id": "text",
"user_id": "text",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"meta": {
"ANY_ADDITIONAL_PROPERTY": null
},
"pmql": "text",
"title": "text",
"type": "task"
}
Display a listing of columns.
ID of saved search to return
GET /api/1.0/saved-searches/{savedSearchId}/columns HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Categorized list of columns
{
"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"
}
]
}
Display a listing of the resource.
ID of saved search to return
Filter results by string. Searches First Name, Last Name, Email and Username.
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/saved-searches/{savedSearchId}/users HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of users
{
"data": [
{
"email": "name@gmail.com",
"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-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z"
}
],
"birthdate": "2025-07-05",
"delegation_user_id": "text",
"manager_id": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"force_change_password": true,
"id": 1,
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"deleted_at": "2025-07-05T04:25:52.647Z"
}
],
"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
}
}
Display a listing of the resource.
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/saved-searches/{savedSearchId}/groups HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of groups
{
"data": [
{
"name": "text",
"description": "text",
"manager_id": 1,
"status": "ACTIVE",
"created_at": "2025-07-05T04:25:52.647Z",
"updated_at": "2025-07-05T04:25:52.647Z",
"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
}
}
Get a list of icons available for SavedSearches.
10
GET /api/1.0/saved-searches/icons HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of icons for saved searches
{
"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
}
}
Last updated