Pivot reports API

Create, read, or edit your reports using the Pivot API.

Self-hosted customers need a license with this reports feature.

Get all reports or a get single named report

Returns a list of all reports, or returns a report with a {name} that you specify.

URL

GET /api/v1/reports/{name}

Success response

Code	Description
200	OK

Selected error response

Code	Example body
404 Not Found	”error": "Not found."

Sample request

curl --location --request GET 'http://localhost:9095/api/v1/reports' \
--header 'x-imply-api-token:<token>'

Response body

[
  {
    "name": "string",
    "title": "string",
    "owner": "string",
    "description": "string",
    "creationDate": "2021-05-03",
    "type": "overall",
    "timeFrame": {
      "startDay": 0,
      "startTime": 0,
      "interval": "previous_day"
    },
    "deliver": {
      "frequency": "string",
      "frequencyType": "fixed",
      "day": 0,
      "dayType": "of-month",
      "time": 0
    },
    "essence": {
      "dataCube": "string"
    },
    "externalEmails": [
      "string"
    ],
    "timezone": "string",
    "recipients": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "admins": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "sendDataFile": true,
    "fileFormat": "csv",
    "downloadLimit": 0,
    "disabled": false,
    "sendEmail": true
  }
]

Create or update a report by name

Creates or updates a report with a {name} that you specify.

URL

POST /api/v1/reports/{name}

Request body

curl -X POST --header "Content-Type:application/json" --header "x-imply-api-token:<token>" --data '
{
  "report": {
    "name": "string",
    "title": "string",
    "owner": "string",
    "description": "string",
    "creationDate": "2021-05-03",
    "type": "overall",
    "timeFrame": {
      "startDay": 0,
      "startTime": 0,
      "interval": "previous_day"
    },
    "deliver": {
      "frequency": "string",
      "frequencyType": "fixed",
      "day": 0,
      "dayType": "of-month",
      "time": 0
    },
    "essence": {
      "dataCube": "string"
    },
    "externalEmails": [
      "string"
    ],
    "timezone": "string",
    "recipients": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "admins": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "sendDataFile": true,
    "fileFormat": "csv",
    "downloadLimit": 0,
    "disabled": false,
    "sendEmail": true
  }
}

Success response

Code	Description
200	OK

Selected error response

Code	Example body
404 Not Found	”error": "Not found."

Response body

[
  {
    "name": "string",
    "title": "string",
    "owner": "string",
    "description": "string",
    "creationDate": "2021-05-03",
    "type": "overall",
    "timeFrame": {
      "startDay": 0,
      "startTime": 0,
      "interval": "previous_day"
    },
    "deliver": {
      "frequency": "string",
      "frequencyType": "fixed",
      "day": 0,
      "dayType": "of-month",
      "time": 0
    },
    "essence": {
      "dataCube": "string"
    },
    "externalEmails": [
      "string"
    ],
    "timezone": "string",
    "recipients": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "admins": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "sendDataFile": true,
    "fileFormat": "csv",
    "downloadLimit": 0,
    "disabled": false,
    "sendEmail": true
  }
]

Delete a report by name

Deletes a report with a {name} that you specify.

URL

DELETE /api/v1/reports/{name}

Sample request

curl -X DELETE --header "x-imply-api-token:<token>" localhost:9095/api/v1/reports/<reportName>

Success response

Code	Description
200	OK

Selected error response

Code	Example body
404 Not Found	”error": "Not found."