WebsiteGuide & TutorialBlogBook a Demo

Custom Reporting

Custom report endpoints.

Delete Custom Chart

DELETE https://{{account_id}}.acquire.io/api/v1​/analytics/custom-reporting/delete-custom-chart

Delete a custom report. Warning: This action cannot be undone.

Query Parameters

Name
Type
Description

report_key

string

Id of chart to delete

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

{
  "data": {
    "success": true,
    "data": {
      "title": "test chart",
      "config": [
        {
          "key": "id",
          "filters": [
            {
              "key": "id",
              "conditions": [
                {
                  "key": "is",
                  "searchValue": [
                    "1"
                  ]
                }
              ]
            }
          ],
          "joinType": "AND",
          "availableAggregation": [
            "group_by",
            "count",
            "list"
          ],
          "label": "Id"
        }
      ],
      "chartKey": "test-chart",
      "chartType": "table",
      "tenantId": "4wic4e",
      "id": 50,
      "data": [
        {
          "main_case_id": 1,
          "main_contact_id": 1,
          "id": 1
        }
      ],
      "totalCount": 1
    }
  }
}

Create Custom Chart

POST https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/generate-chart

Create a custom chart.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Request Body

Name
Type
Description

config

array

Array of objects. The configuration of your chart. See example below.

chartType

string

Specify the type of chart. Available charts: "table"

title

string

Chart title

Body(raw) for Create Custom Chart

Edit Custom Report

POST https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/edit-custom-report

Edit a custom report.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Request Body

Name
Type
Description

reportKey

string

Key for report which you want to edit. This is the report's current name.

description

string

Add a description for the report

reportName

string

Name of the report

Body(raw) for Edit Custom Report

Create Custom Report

POST https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/generate-report

Create a custom report.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Request Body

Name
Type
Description

objectKey

string

Selected object type. You can get object keys by calling the Get Data Points endpoint mentioned below.

description

string

A short description of the chart

reportName

string

Name of report

Body(raw) for Create Custom Report

Delete Custom Report details

DELETE https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/delete-custom-report

Delete a custom report's details. Warning: This action cannot be undone.

Query Parameters

Name
Type
Description

report_key

string

The current name of the report which you want to delete.You can get report key by calling Get All Custom Reports.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Get Custom Report details

GET https://{{account_id}}.acquire.io/api//v1/analytics/custom-reporting/get-custom-report

Retrieve all custom report details.

Query Parameters

Name
Type
Description

report_key

string

Key of report which you want to get data. You can get report key by calling Get All Custom Reports API.

offset

string

This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Get All custom reports

GET https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/get-all-custom-report

Get list of all custom reports with name, description and report key. Report key will be used to get details of custom report.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Get All Datapoints

GET https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/get-data-points

Retrieve a list of all available data points for available objects.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Get Custom Chart with data

GET https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/get-custom-chart

Retrieve data of chart with pagination enabled.

Query Parameters

Name
Type
Description

limit

string

Define limit how many records you want per page out of total records

page

string

Page number for which you want data

preview

string

If you want total count in response then send its value as false else true.

offset

string

This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00

chart_id

string

Id of chart for which you want data.You can get chart id from get_custom_report api.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Schedule Chart

POST https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/schedule-mail

Schedule a chart

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

Request Body

Name
Type
Description

offset

string

This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00

schedulePeriod

object

Object for configuration. period => "monthly" or "weekly" or "daily", daysOfWeek => "monday"

emails

array

Comma separated emails to which you want to send report

chartId

string

ID of chart which you want schedule

Body (raw) for Schedule Chart

Remove Scheduled Chart

DELETE https://{{account_id}}.acquire.io/api/v1/analytics/custom-reporting/delete-schedule-mail

Remove already scheduled chart

Query Parameters

Name
Type
Description

scheduleMailId

number

Id of scheduled chart.You can get this id using get-custom-chart API.

Headers

Name
Type
Description

Authorization

string

Bearer ***YOUR_API_KEY***

PreviousAnalyticsNextGeneral Analytics

Last updated