# Report

# Report List

The request for the list of all currently configured reports for current user. This list does not contain the reports which not supported in current API version. For more information about the API version see here. The returned list only includes reports for which the current user is licensed to run.

# Request

# Endpoint

/report

# Parameters:

There are no query parameters.

# Body

There is no request body.

# Sample URL

https://sampleurl.akixi.com/CCS/API/v1/report

# Response

The response contain the list of report items that represents configured reports for corresponding user.

# Example Of Successful Result With 200 HTTP Status Code:

[
    {
        "ID": "037aa2f4d69de9b2:7b46ab7e:16da5f5af94:-7faa",
        "Type": 21,
        "Description": "ACD Agent List",
        "IsLicensed": true
    },
    {
        "ID": "037aa2f4d69de9b2:7b46ab7e:16da5f5af94:-7fba",
        "Type": 0,
        "Description": "Active Contact List",
        "IsLicensed": true
    },
    {
        "ID": "037aa2f4d69de9b2:7b46ab7e:16da5f5af94:-7fb8",
        "Type": 100,
        "Description": "Desktop Wallboard",
        "IsLicensed": true
    }
]

# Fields Of Report Item:

# ID

• type: string

The identifier of the report. This identifier could be used to retrieve the report data in Report Execution And Data Retrieval request.

# Type

• type: number

The type of the report. See following table with supported report types:

# Description

• type: string

The description of the report.

# IsLicensed

• type: boolean

Whether the authenticated user has permissions (is licensed) to run the report and get the report data.

# Code Snippets

See the following code snippets to help you start with the integration:

curl -X GET \
  https://host/CCS/API/v1/report \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === XMLHttpRequest.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://host/CCS/API/v1/report");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=B3A0BBA6E70EB78AA059880BCE1EE1B9;"
}

conn.request("GET", "CCS,API,v1,report", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/report")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();

# Report Execution And Data Retrieval

The request for report execution and data retrieval. If the report is not running, it will be firstly executed. In case of running report the request returns data immediately. The execution can take couple of seconds and during this initialisation period the request will return only the status of execution.

# Request

# Endpoint

/report/{ID}/exec

# Parameters:

# Body

There is no request body.

# Sample URL

https://sampleurl.akixi.com/CCS/API/v1/report/11d1def534ea1be0%3A-5bd31c43%3A13fc7b254d1%3A-556d/exec?rowID=501&rowsPerPage=100

# Response

# Example Of Report Initialisation Response With 200 HTTP Status Code:

{
    "ID": "037aa2f4d69de9b2:7b46ab7e:16da5f5af94:-7faa",
    "Type": 21,
    "Description": "ACD Agent List",
    "Duration": "REALTIME",
    "ExecutionStatus": "WAITING"
}

# Fields:

# ID

• type: string

The report identifier.

# Type

• type: number

The report type. See the table of supported types above.

# Description

• type: string

The report description configured in portal.

# Duration

• type: string

The period of the report for which the stats were aggregated. See the table of possible values:

# ExecutionStatus

• type: string

The executions status of the corresponding report. See the table of possible values:

# Example Of Report Initialisation Response With 200 HTTP Status Code:

{
    "ID": "037aa2f4d69de9b2:7b46ab7e:16da5f5af94:-7faf",
    "Type": 20,
    "Description": "Extension List",
    "Duration": "REALTIME",
    "ExecutionStatus": "ACTIVE",
    "ServerTimeZone": "CET",
    "UserTimeZone": "CET",
    "Header": {
        "SortedBy": [],
        "FieldDefinitions": [
            {
                "ID": 1500,
                "DataType": "TEXT",
                "Description": "Device ID"
            },
            {
                "ID": 1550,
                "DataType": "TEXT_TRUNCATABLE",
                "Description": "Device Name"
            },
            {
                "ID": 2100,
                "DataType": "INTEGER_OR_LONG",
                "Description": "Active Calls"
            }
        ]
    },
    "Body": {
        "Rows": [
            {
                "ID": "46995813da8f9fc2:550c082c:16ee9a23ed7:-5604",
                "Description": "Jack Burns",
                "Statistics": [
                    {
                        "ID": 1500,
                        "Value": "100"
                    },
                    {
                        "ID": 1550,
                        "Value": "Jack Burns"
                    },
                    {
                        "ID": 2100,
                        "Value": "0"
                    }
                ]
            },
            {
                "ID": "46995813da8f9fc2:550c082c:16ee9a23ed7:-5603",
                "Description": "Ruby Wagner",
                "Statistics": [
                    {
                        "ID": 1500,
                        "Value": "101"
                    },
                    {
                        "ID": 1550,
                        "Value": "Ruby Wagner"
                    },
                    {
                        "ID": 2100,
                        "Value": "0"
                    }
                ]
            }
        ]
    },
    "Footer": {
        "ID": "46995813da8f9fc2:550c082c:16ee9a23ed7:-5605",
        "Description": "All Extensions",
        "Statistics": [
            {
                "ID": 1500,
                "Value": ""
            },
            {
                "ID": 1550,
                "Value": ""
            },
            {
                "ID": 2100,
                "Value": ""
            }
        ]
    }
}

Fully initialised report data response contains all fields that were described above for the example of response where the report is not running yet. The next fields are generated only in the case that report is active (running / initialised).

The report content is composed of 3 main objects: The report header, report body and report footer.

The header object holds "metadata" information about the generated statistics in the body and footer.

# See the detailed description of the FieldDefinitions array items fields:

# ID

• type: number

The identifier of the statistic. This identifier should be used to pair the statistic definition with the statistic details in the row object in the in the report body.

# DataType

• type: string

The type of the statistic. See the table with possible values:

# Description

• type: string

The description of the statistic.

# The report body consists of report rows array items where each item contains following fields:

# ID

• type: string

The identifier of the report row.

# Description

• type: string

The row specific description.

# Each report row has statistics array where each item contains following fields:

# ID

• type: string

The identifier of the statistic

# Value

• type: string

The formatted stringified value of corresponding statistic.

# Code Snippets

See the following code snippets to help you start with the integration:

 curl -X GET \
  https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa/exec \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === XMLHttpRequest.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa/exec");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=2F6C4C46E372F89414388BD9A8429785;"
}

conn.request("GET", "CCS,API,v1,report,037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa,exec", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa/exec")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();

# Report Execution From Template

The request for executing a report from template. The execution will return the report ID and its execution status.

# Request

# Endpoint

/report/template/{templateID}/telsys/{telsysID}/partition/{partitionID}

# Parameters:

There are no query parameters.

# Body

There is no request body.

# Sample URL

https://sampleurl.akixi.com/CCS/API/v1/report/template/cfd8f56fdaec3768:2ebeab07:1844366b7aa:-7f74/telsys/1/partition/1

# Response

# Example Of Template Execution Response With 200 HTTP Status Code:

{
    "ID": "e967f4c207accc67:72524d4f:18863ca33e2:-7faf",
    "Type": 50,
    "Description": "TempReport Half Hour Interval Abandoned Calls_1",
    "Duration": "X_DAYS_PREVIOUS",
    "ExecutionStatus": "WAITING"
}

# Fields:

# ID

• type: string

The report identifier.

# Type

• type: number

The report type. See the table of supported types above.

# Description

• type: string

The report description configured in portal.

# Duration

• type: string

The period of the report for which the stats were aggregated. See the table of possible values:

# ExecutionStatus

• type: string

The executions status of the corresponding report. See the table of possible values:

# Code Snippets

See the following code snippets to help you start with the integration:

 curl -X POST \
  https://host/CCS/API/v1/report/template/cfd8f56fdaec3768:2ebeab07:1844366b7aa:-7f74/telsys/1/partition/1 \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === XMLHttpRequest.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://host/CCS/API/v1/report/template/cfd8f56fdaec3768:2ebeab07:1844366b7aa:-7f74/telsys/1/partition/1");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=2F6C4C46E372F89414388BD9A8429785;"
}

conn.request("POST", "CCS,API,v1,report,template,cfd8f56fdaec3768:2ebeab07:1844366b7aa:-7f74,telsys,1,partition,1", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.post("https://host/CCS/API/v1/report/template/cfd8f56fdaec3768:2ebeab07:1844366b7aa:-7f74/telsys/1/partition/1")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();

# Report Execution And Data Retrieval Template

The request for report execution and data retrieval. If the report is not running, it will be firstly executed. In case of running report the request returns data immediately. The execution can take couple of seconds and during this initialisation period the request will return only the status of execution.

# Request

# Endpoint

/report/{ID}

# Parameters:

There are no query parameters.

# Body

There is no request body.

# Sample URL

https://sampleurl.akixi.com/CCS/API/v1/report/11d1def534ea1be0%3A-5bd31c43%3A13fc7b254d1%3A-556d

# Response

# Example Of Report Initialisation Response With 200 HTTP Status Code:

{
    "ID": "037aa2f4d69de9b2:7b46ab7e:16da5f5af94:-7faa",
    "Type": 21,
    "Description": "ACD Agent List",
    "Duration": "REALTIME",
    "ExecutionStatus": "WAITING"
}

# Fields:

# ID

• type: string

The report identifier.

# Type

• type: number

The report type. See the table of supported types above.

# Description

• type: string

The report description configured in portal.

# Duration

• type: string

The period of the report for which the stats were aggregated. See the table of possible values:

# ExecutionStatus

• type: string

The executions status of the corresponding report. See the table of possible values:

# Example Of Report Initialisation Response With 200 HTTP Status Code:

{
    "ID": "037aa2f4d69de9b2:7b46ab7e:16da5f5af94:-7faf",
    "Type": 20,
    "Description": "Extension List",
    "Duration": "REALTIME",
    "ExecutionStatus": "ACTIVE",
    "ServerTimeZone": "CET",
    "UserTimeZone": "CET",
    "Header": {
        "SortedBy": [],
        "FieldDefinitions": [
            {
                "ID": 1500,
                "DataType": "TEXT",
                "Description": "Device ID"
            },
            {
                "ID": 1550,
                "DataType": "TEXT_TRUNCATABLE",
                "Description": "Device Name"
            },
            {
                "ID": 2100,
                "DataType": "INTEGER_OR_LONG",
                "Description": "Active Calls"
            }
        ]
    },
    "Body": {
        "Rows": [
            {
                "ID": "46995813da8f9fc2:550c082c:16ee9a23ed7:-5604",
                "Description": "Jack Burns",
                "Statistics": [
                    {
                        "ID": 1500,
                        "Value": "100"
                    },
                    {
                        "ID": 1550,
                        "Value": "Jack Burns"
                    },
                    {
                        "ID": 2100,
                        "Value": "0"
                    }
                ]
            },
            {
                "ID": "46995813da8f9fc2:550c082c:16ee9a23ed7:-5603",
                "Description": "Ruby Wagner",
                "Statistics": [
                    {
                        "ID": 1500,
                        "Value": "101"
                    },
                    {
                        "ID": 1550,
                        "Value": "Ruby Wagner"
                    },
                    {
                        "ID": 2100,
                        "Value": "0"
                    }
                ]
            }
        ]
    },
    "Footer": {
        "ID": "46995813da8f9fc2:550c082c:16ee9a23ed7:-5605",
        "Description": "All Extensions",
        "Statistics": [
            {
                "ID": 1500,
                "Value": ""
            },
            {
                "ID": 1550,
                "Value": ""
            },
            {
                "ID": 2100,
                "Value": ""
            }
        ]
    }
}

Fully initialised report data response contains all fields that were described above for the example of response where the report is not running yet. The next fields are generated only in the case that report is active (running / initialised).

The report content is composed of 3 main objects: The report header, report body and report footer.

The header object holds "metadata" information about the generated statistics in the body and footer.

# See the detailed description of the FieldDefinitions array items fields:

# ID

• type: number

The identifier of the statistic. This identifier should be used to pair the statistic definition with the statistic details in the row object in the in the report body.

# DataType

• type: string

The type of the statistic. See the table with possible values:

# Description

• type: string

The description of the statistic.

# The report body consists of report rows array items where each item contains following fields:

# ID

• type: string

The identifier of the report row.

# Description

• type: string

The row specific description.

# Each report row has statistics array where each item contains following fields:

# ID

• type: string

The identifier of the statistic

# Value

• type: string

The formatted stringified value of corresponding statistic.

# Code Snippets

See the following code snippets to help you start with the integration:

 curl -X GET \
  https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === XMLHttpRequest.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=2F6C4C46E372F89414388BD9A8429785;"
}

conn.request("GET", "CCS,API,v1,report,037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();

# Report Close

The request for closing an open report. The execution will return an empty response when finished.

# Request

# Endpoint

/report/{ID}

# Parameters:

There are no query parameters.

# Body

There is no request body.

# Sample URL

https://sampleurl.akixi.com/CCS/API/v1/report/11d1def534ea1be0%3A-5bd31c43%3A13fc7b254d1%3A-556d

# Response

Empty response with 200 HTTP status code.

# Code Snippets

See the following code snippets to help you start with the integration:

 curl -X DELETE \
  https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === XMLHttpRequest.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=2F6C4C46E372F89414388BD9A8429785;"
}

conn.request("DELETE", "CCS,API,v1,report,037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.delete("https://host/CCS/API/v1/report/037aa2f4d69de9b2%3A7b46ab7e%3A16da5f5af94%3A-7faa")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();