Statisticsv2

All the endpoints that can be called on the Statisticsv2 controller.

All the endpoints require the API_STATISTICS permission, except for:

POST dashboardDelete
PUT dashboard

Which require the DASHBOARD_CUD permission.

options

get

Returns the options available to the statistics showQuery and showData.

Authorizations

HTTPRequired

Responses

200

Successful response

application/json

get

/api/v2/statisticsv2/options

GET /api/v2/statisticsv2/options HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

dashboard

get

Returns all the dashboard data by the dashboard ID.

Authorizations

HTTPRequired

Responses

200

Successful response

application/json

get

/api/v2/statisticsv2/dashboard

GET /api/v2/statisticsv2/dashboard HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

dashboard

post

Creates a new dashboard.

Authorizations

HTTPRequired

Body

Responses

200

Successful response

application/json

post

/api/v2/statisticsv2/dashboard

POST /api/v2/statisticsv2/dashboard HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

dashboard

put

Updates this dashboard's name.

Authorizations

HTTPRequired

Body

idstringOptional

type: number

The dashboard's ID.

namestringOptional

type: ^[0-9a-zA-Z\' :+*]+$ = ' '

Responses

200

Successful response

application/json

put

/api/v2/statisticsv2/dashboard

PUT /api/v2/statisticsv2/dashboard HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 27

"id='text'&name='text'"

200

Successful response

dashboardDelete

post

Deletes this dashboard and its widgets.

Authorizations

HTTPRequired

Body

idstringOptional

type: number

Responses

200

Successful response

application/json

post

/api/v2/statisticsv2/dashboardDelete

POST /api/v2/statisticsv2/dashboardDelete HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 13

{
  "id": "text"
}

200

Successful response

dashboards

get

Returns all the dashboards.

Authorizations

HTTPRequired

Responses

200

Successful response

application/json

get

/api/v2/statisticsv2/dashboards

GET /api/v2/statisticsv2/dashboards HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

widgetData

get

Returns all the data of this widget.

Authorizations

HTTPRequired

Responses

200

Successful response

application/json

get

/api/v2/statisticsv2/widgetData

GET /api/v2/statisticsv2/widgetData HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

showData

get

Returns all data of this widget to show.

Widget data specifics can be added how is shown in the example. Adjust to your own needs.

Authorizations

HTTPRequired

Responses

200

application/json

Responseobject

get

/api/v2/statisticsv2/showData

GET /api/v2/statisticsv2/showData HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

{
  "type": "item",
  "item": {
    "buckets": [
      "2024-08-26",
      "2024-08-27",
      "2024-08-28",
      "2024-08-29",
      "2024-08-30",
      "2024-08-31",
      "2024-09-01"
    ],
    "facts": {
      "Tickets assigned": [
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "Tickets handled": [
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  }
}

post

Creates a new widget.

See the example for how to write the dataURL.

Authorizations

HTTPRequired

Body

dashboardIDstringOptional

type: number

titlestringOptional

type: ^[0-9a-zA-Z :+*\-]+$ = ' '

dataURLstringOptional

type: ^[a-zA-Z0-9\.\:\/\-\ \=\?\&\[\]\_\:\+\*\@]+$ = ' '

Identical to the way showData allows these requested paramters in the URL.

viewTypestringOptional

type: ^([a-zA-Z]+)$ = 'table'

fontSizeTitlestringOptional

type: number = null

fontSizeDatastringOptional

type: number = null

pivotOnColumnstringOptional

type: ^([0-9]+)$ = 0

ticketArchivedstringOptional

type: boolean = false

position_xstringOptional

type: number = 0

position_ystringOptional

type: number = 0

widthstringOptional

type: number = 5

heightstringOptional

type: number = 5

Responses

200

application/json

Responseobject

post

/api/v2/statisticsv2/widget

POST /api/v2/statisticsv2/widget HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 235

{
  "dashboardID": "text",
  "title": "text",
  "dataURL": "text",
  "viewType": "text",
  "fontSizeTitle": "text",
  "fontSizeData": "text",
  "pivotOnColumn": "text",
  "ticketArchived": "text",
  "position_x": "text",
  "position_y": "text",
  "width": "text",
  "height": "text"
}

200

{
  "type": "item",
  "item": {
    "widgetID": 10
  }
}

put

Updates an existing widget.

See the example for how to write the dataURL. You need to fill in all the data, not just the changed data.

Authorizations

HTTPRequired

Body

idstringOptional

type: number

titlestringOptional

type: ^[0-9a-zA-Z :+*\-]+$ = ' '

dataURLstringOptional

type: ^[a-zA-Z0-9\.\:\/\-\ \=\?\&\[\]\_\:\+\*\@]+$ = ' '

viewTypestringOptional

type: ^([a-zA-Z]+)$ = 'table'

fontSizeTitlestringOptional

type: number = null

fontSizeDatastringOptional

type: number = null

pivotOnColumnstringOptional

type: number = 0

ticketArchivedstringOptional

type: boolean = false

Responses

200

application/json

Responseobject

put

/api/v2/statisticsv2/widget

PUT /api/v2/statisticsv2/widget HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 155

"id='text'&title='text'&dataURL='text'&viewType='text'&fontSizeTitle='text'&fontSizeData='text'&pivotOnColumn='text'&ticketArchived='text'"

200

{
  "type": "result",
  "status": "success",
  "message": "Widget saved."
}

widgetDelete

post

Deletes this widget.

Authorizations

HTTPRequired

Body

idstringOptional

type: number

Responses

200

Successful response

application/json

post

/api/v2/statisticsv2/widgetDelete

POST /api/v2/statisticsv2/widgetDelete HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 13

{
  "id": "text"
}

200

Successful response

widgetPosition

post

Updates this widget's position.

Authorizations

HTTPRequired

Body

idstringOptional

type: number

widthstringOptional

type: number = null

heightstringOptional

type: number = null

xstringOptional

type: number = null

ystringOptional

type: number = null

Responses

200

Successful response

application/json

post

/api/v2/statisticsv2/widgetPosition

POST /api/v2/statisticsv2/widgetPosition HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 66

{
  "id": "text",
  "width": "text",
  "height": "text",
  "x": "text",
  "y": "text"
}

200

Successful response

widgetAutoRefresh

put

Sets the setting to automatically refresh this widget on or off.

Authorizations

HTTPRequired

Body

idstringOptional

type: number

statestringOptional

type: ^(0|1)$

Responses

200

Successful response

application/json

put

/api/v2/statisticsv2/widgetAutoRefresh

PUT /api/v2/statisticsv2/widgetAutoRefresh HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 28

"id='text'&state='text'"

200

Successful response

widgetSendOptions

get

Returns the info on where this widget's data is being sent to.

Authorizations

HTTPRequired

Responses

200

Successful response

application/json

get

/api/v2/statisticsv2/widgetSendOptions

GET /api/v2/statisticsv2/widgetSendOptions HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

widgetSendOptions

post

Creates a setting to send all widget data to an email.

Authorizations

HTTPRequired

Body

idstringOptional

type: number

sendFrequencystringOptional

type: ^([0-9a-zA-Z\ \: \*]+)$

Set for if you want to send it with a regular interval.

toAddressesstringOptional

type: ^([a-zA-Z0-9 @+-_.,]+)$

Has to be an email address or multiple email addresses comma-separated

Responses

200

Successful response

application/json

post

/api/v2/statisticsv2/widgetSendOptions

POST /api/v2/statisticsv2/widgetSendOptions HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 57

{
  "id": "text",
  "sendFrequency": "text",
  "toAddresses": "text"
}

200

Successful response

downloadData

get

Returns and downloads all data of this widget, or of the data you sent along with the request.

You either need to send the widget/panel ID, or the data in such a way provided in the example.

Authorizations

HTTPRequired

Responses

200

text/plain

Responsestring

get

/api/v2/statisticsv2/downloadData

GET /api/v2/statisticsv2/downloadData HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

"Time"	"Tickets assigned"	"Tickets handled"
"2024-08-26"	"0"	"0"	

"2024-08-27"	"0"	"0"	

"2024-08-28"	"0"	"0"	

"2024-08-29"	"0"	"0"	

"2024-08-30"	"0"	"0"	

"2024-08-31"	"0"	"0"	

"2024-09-01"	"0"	"0"

PreviousRaw NextTicket

Last updated 1 month ago