API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dashboard_widgets

Retrieves the collection of dashboard_widgets resources.

Retrieves the collection of dashboard_widgets resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[title]
boolean
exists[description]
boolean
exists[dataProcessor]
boolean
exists[reports]
boolean
exists[notes]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[title]
string
Default: "asc"
Enum: "asc" "desc"
order[viewName]
string
Default: "asc"
Enum: "asc" "desc"
order[viewNameAPI]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[description]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[priority]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dataProcessor
string
dataProcessor[]
Array of strings
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
priority_range[between]
string
priority_range[gt]
string
priority_range[gte]
string
priority_range[lt]
string
priority_range[lte]
string
priority
integer
priority[]
Array of integers
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
viewName_end_with
string
viewName_partial
string
viewName_start_with
string
viewName
string
viewName[]
Array of strings
viewNameAPI_end_with
string
viewNameAPI_partial
string
viewNameAPI_start_with
string
viewNameAPI
string
viewNameAPI[]
Array of strings

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a dashboard_widgets resource.

Creates a dashboard_widgets resource.

Authorizations:
JWT
Request Body schema:
required

The new dashboard_widgets resource

title
string or null

title

description
string or null

description

viewName
string

viewName

viewNameAPI
string

viewName

dataanalysis_dataprocessors.jsonld-add_post (object) or null
priority
integer
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "viewName": "string",
  • "viewNameAPI": "string",
  • "dataProcessor": {
    },
  • "priority": 0,
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "title": "string",
  • "description": "string",
  • "viewName": "string",
  • "viewNameAPI": "string",
  • "dataProcessor": {
    },
  • "priority": 0,
  • "notes": "string",
  • "shortcode": "DW",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "reportsListing": "string",
  • "requestParamsListing": [
    ],
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}