Skip to content

Managing Reports

This describes the web services that manage requesting and retrieving reports from Aculab Cloud.

Reports can take time to be generated as they usually involve substantial database access. As a result, separate web services for starting, monitoring and downloading reports are provided. Note that reports can be downloaded or deleted only once they have completed.

Reports can also be accessed via the Reports menu.

The reports contain a list of comma-separate values.

Note

 This is a low level API. For information on higher level APIs see the Web Services Language Wrappers

Authorisation

This API uses basic authentication, using your cloud account username and API Access Key.
Username : cloudID/username (e.g. 1-2-0/bob@example.com)
Password : API Access Key

Report Start

This starts generation of a new report containing comma-separated values.

Request
URL : https://ws-[cloudID].aculabcloud.net/report_start
Methods : GET, POST
Parameter Required/Optional Default Description
report required The content of the report. One of the following:
  • adr application data record
  • cdr call data record
  • fdr feature data record
  • msg message record
  • err error record
  • csr chargeable service record
from required The point at which at the report should start in the format YYYY-MM-DD_hh:mm:ss.
to required The point at which the report should end in the format YYYY-MM-DD_hh:mm:ss.

Response

A JSON object containing the following properties:

Parameter Type Availability Description
filename string always The filename of the report.

Example

Request
https://ws-[cloudID].aculabcloud.net/report_start?report=adr&from=2013-05-01_13:00:00&to=2013-05-03_13:00:00
Response
  {
    filename: "1-2-0_bill.blogs@acompany.com_adr_2013-05-01_13:00:00_2013-05-03_13:00:00.csv"
  }

Report Progress

This queries the status of any reports currently in progress.

Request
Url : https://ws-[cloudID].aculabcloud.net/report_progress
Methods : GET, POST

Response

A json object containing the names of any reports that are currently in progress. For each report the following parameters are returned:

Parameter Type Availability Description
record integer always The number of records written to the report.
progress string always The progress percentage (based on the start and end time).

Example

Request
https://ws-[cloudID].aculabcloud.net/report_progress
Response
  {
    "1-2-0_bill.blogs@acompany.com_adr_2013-05-06_13:00:00_2013-05-08_13:00:00.csv":
    {
      "record": 183,
      "progress": "63.15%"
    }
  }

Report Cancel

This cancels generation of a report.

Request
Url : https://ws-[cloudID].aculabcloud.net/report_cancel
Methods : GET, POST
Parameter Required/Optional Default Description
filename required the filename of the report to cancel.

Response

Nothing.

Example

Request
https://ws-[cloudID].aculabcloud.net/report_cancel?filename=1-2-0_bill.blogs@acompany.com_adr_2013-05-06_13:00:00_2013-05-08_13:00:00.csv

Report List

This lists all completed reports.

Request
Url : https://ws-[cloudID].aculabcloud.net/report_list
Methods : GET, POST

Response

A json object containing the names of any reports that have completed. For each report the following parameters are returned:

Parameter Type Availability Description
modified string always The last modification time of the report.
size integer always The size of the report in bytes.

Example

Request
https://ws-[cloudID].aculabcloud.net/report_list
Response
  {
    "1-2-0_bill.blogs@acompany.com_adr_2013-05-01_13:00:00_2013-05-03_13:00:00.csv":
    {
      "modified": "2013-05-03_14:17:09",
      "size": 260
    }
  }

Report Get

This downloads a completed report from Aculab Cloud.

Request
Url : https://ws-[cloudID].aculabcloud.net/report_get
Methods : GET, HEAD, POST
Parameter Required/Optional Default Description
filename required The filename of the report to download.

Response

The report file data.

Example

Request
https://ws-[cloudID].aculabcloud.net/report_get?filename=1-2-0_bill.blogs@acompany.com_adr_2013-05-06_13:00:00_2013-05-08_13:00:00.csv

Delete

This deletes a completed report from Aculab Cloud.

Request
URL : https://ws-[cloudID].aculabcloud.net/report_delete
Methods : DELETE, GET, POST
Parameter Required/Optional Default Description
filename required the filename of the report to delete.

Response

Nothing.

Example

Request
https://ws-[cloudID].aculabcloud.net/report_delete?filename=1-2-0_bill.blogs@acompany.com_adr_2013-05-06_13:00:00_2013-05-08_13:00:00.csv