Informizely customer feedback surveys
By using the Aculab site, you agree with our use of cookies.

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.

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

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

    Url : https://ws.aculabcloud.net/report_start
    Methods : GET, POST

    ParameterValueDescription
    report string the required content of the report. One of "adr", "cdr", "msg" or "err".
    • adr application data record
    • cdr call data record
    • msg SMS message record
    • err error record
    from string the point at which at the report should start in the format YYYY-MM-DD_hh:mm:ss.
    to string the point at which the report should end in the format YYYY-MM-DD_hh:mm:ss.

    Returns:

    A JSON object containing the following properties:

    ParameterValueDescription
    filename string the filename of the report.

    Example:

    https://ws.aculabcloud.net/report_start?report=adr&from=2013-05-01_13:00:00&to=2013-05-03_13:00:00

    Response:

      {
        filename: "This email address is being protected from spambots. You need JavaScript enabled to view it._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.

    Url : https://ws.aculabcloud.net/report_progress
    Methods : GET, POST

    Returns:

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

    ParameterValueDescription
    record integer the number of records written to the report.
    progress string a progress percentage (based on the start and end time).

    Example:

    https://ws.aculabcloud.net/report_progress

    Response:

      {
        "This email address is being protected from spambots. You need JavaScript enabled to view it._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.

    Url : https://ws.aculabcloud.net/report_cancel
    Methods : GET, POST

    ParameterValueDescription
    filename string the filename of the report to cancel.

    Returns:

    Nothing.

    Example:

    https://ws.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.

    Url : https://ws.aculabcloud.net/report_list
    Methods< : GET, POST

    Returns:

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

    ParameterValueDescription
    modified string the last modification time of the report.
    size string the size of the report in bytes.

    Example:

    https://ws.aculabcloud.net/report_list

    Response:

      {
        "This email address is being protected from spambots. You need JavaScript enabled to view it._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.

    Url : https://ws.aculabcloud.net/report_get
    Methods : GET, HEAD, POST

    ParameterValueDescription
    filename string the filename of the report to download.

    Returns:The report file data.

    Example:

    https://ws.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

  • Report Delete

    This deletes a completed report from Aculab Cloud.

    Url : https://ws.aculabcloud.net/report_delete
    Methods : DELETE, GET, POST

    ParameterValueDescription
    filename string the filename of the report to delete.

    Returns:

    Nothing.

    Example:

    https://ws.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