API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

dashboard_reports

Retrieves a dashboard_reports resource.

Retrieves a dashboard_reports resource.

Authorizations:
JWT
path Parameters
id
required
string

dashboard_reports identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "title": "string",
  • "description": "string",
  • "notes": "string",
  • "reportWidgets": [
    ],
  • "entityName": "string",
  • "type": {
    },
  • "shortcode": "DR",
  • "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",
  • "sortedReportWidgets": [
    ],
  • "widgetsCount": null,
  • "reportWidgetsListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the dashboard_reports resource.

Replaces the dashboard_reports resource.

Authorizations:
JWT
path Parameters
id
required
string

dashboard_reports identifier

Request Body schema:
required

The updated dashboard_reports resource

title
string or null

title

description
string or null

description

notes
string or null
entityName
string or null
required
object (dashboard_reporttypes.jsonld-add_post)

Type.

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",
  • "notes": "string",
  • "entityName": "string",
  • "type": {
    },
  • "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",
  • "notes": "string",
  • "reportWidgets": [
    ],
  • "entityName": "string",
  • "type": {
    },
  • "shortcode": "DR",
  • "id": 0,
  • "slug": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sortedReportWidgets": [
    ],
  • "widgetsCount": null,
  • "reportWidgetsListing": "string",
  • "uniqueId": "string",
  • "taggingListing": "string"
}

Removes the dashboard_reports resource.

Removes the dashboard_reports resource.

Authorizations:
JWT
path Parameters
id
required
string

dashboard_reports identifier

Responses