Reporting

Get averages

GET reports/averages

Query string parameters

activity_type_ids UUID - Comma separated list of ids
created_from_lead boolean
indicators string - Comma separated list of ids
- Required
interval string
- one of: year, quarter, month, week, day, hour, minute, second
- default value: month
lead_sources string - Comma separated list
lead_type_ids UUID - Comma separated list of ids
product_ids UUID - Comma separated list of ids
relations_path_ids UUID - Comma separated list of ids
start_at date
- Y-m-d H:i:s format
end_at date
- Y-m-d H:i:s format

Response

Status code 200

{
    "interval": "month",
    "data": [
        {
            "indicator": "leads.accepted",
            "user": 1,
            "value": 12
        }
    ]
}

Get metrics

GET reports/metrics

Query string parameters

activity_type_ids UUID - Comma separated list of ids
created_from_lead boolean
group_by string
- one of activity_type, company, group, lead_source, lead_type, relations_path, team, user
- default value: user
group_ids string - Comma separated list of ids
indicators string - Comma separated list of indicators
- Required
lead_sources string - Comma separated list
lead_type_ids UUID - Comma separated list of ids
product_ids UUID - Comma separated list of ids
relations_path_ids UUID - Comma separated list of ids
start_at date
- Y-m-d H:i:s format
end_at date
- Y-m-d H:i:s format
team_ids integer - Comma separated list of ids
user_ids integer - Comma separated list of ids

Response

Status code 200

{
    "group_by": [
        "team"
    ],
    "data": [
        {
            "indicator": "leads.accepted",
            "value": 5,
            "team_id": 1
        },
        {
            "indicator": "leads.accepted",
            "value": 4,
            "team_id": 2
        },
        {
            "indicator": "leads.assigned",
            "value": 2,
            "team_id": 1
        },
        {
            "indicator": "leads.assigned",
            "value": 4,
            "team_id": 2
        }
    ]
}

Get time series

GET reports/time-series

Query string parameters

activity_type_ids UUID - Comma separated list of ids
created_from_lead boolean
group_by string
- one of activity_type, company, group, lead_source, lead_type, relations_path, team, user
  - default value: user
group_ids UUID - Comma separated list of ids
indicators string - Comma separated list of indicators
- Required
lead_sources string - Comma separated list
lead_type_ids UUID - Comma separated list of ids
product_ids UUID - Comma separated list of ids
relations_path_ids UUID - Comma separated list of ids
start_at date
- Y-m-d H:i:s format
end_at date
- Y-m-d H:i:s format
team_ids integer - Comma separated list of ids
user_ids integer - Comma separated list of ids

Response

Status Code 200

{
    "group_by": [
        "company"
    ],
    "interval": "month",
    "data": [
        {
            "indicator": "cases.closed",
            "key": "2017-01-01 00:00:00",
            "value": 33,
            "end_at": "2017-01-31 23:59:59",
            "start_at": "2017-01-01 00:00:00"
        },
        {
            "indicator": "cases.closed",
            "key": "2017-02-01 00:00:00",
            "value": 22,
            "end_at": "2017-02-28 23:59:59",
            "start_at": "2017-02-01 00:00:00"
        },
        {
            "indicator": "cases.closed",
            "key": "2017-03-01 00:00:00",
            "value": 23,
            "end_at": "2017-03-31 23:59:59",
            "start_at": "2017-03-01 00:00:00"
        },
        {
            "indicator": "cases.closed",
            "key": "2017-04-01 00:00:00",
            "value": 14,
            "end_at": "2017-04-30 23:59:59",
            "start_at": "2017-04-01 00:00:00"
        }
    ]
}

Get indicators

GET reports/indicators

Return list of available indicators

Response

{
    "data": [
        {
            "name": "accounts.b2b.created",
            "group": "contacts"
        },
        {
            "name": "accounts.b2b.deleted.total",
            "group": "usage"
        },
        {
            "name": "accounts.b2b.total",
            "group": "usage"
        },
        {
            "name": "accounts_contacts.without_address",
            "group": "contacts"
        }
    ]
}

Indicator sets

Get indicator set list

GET reports/indicator-sets

Query string parameters

per_page integer
page integer
ids string - Commas separated list of ids

Response

{
    "pagination": {
        "page": 1,
        "per_page": 50,
        "total": 2
    },
    "data": [
        {
            "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
            "name": "My new set name",
            "indicators": [
                "contacts.b2c.created",
                "leads.accepted",
                "leads.assigned"
            ]
        },
        {
            "id": "1420334c-6d91-481b-a1e8-408037a588dd",
            "name": "Leads accepted and assigned",
            "indicators": [
                "contacts.b2c.created",
                "leads.accepted",
                "leads.assigned"
            ]
        }
    ]
}

Get indicator set

GET reports/indicator-sets/:indicator_set_id

Response

Status Code 200

{
    "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
    "name": "My set",
    "indicators": [
        "leads.accepted",
        "leads.assigned"
    ]
}

Create indicator set

POST reports/indicator-sets

Parameters

name string
- Required
indicators array of indicator names
- Required
- Can't be empty
- indicators.* string

Payload

{
    "name": "My set",
    "indicators": ["leads.accepted", "leads.assigned"]
}

Response
Status Code 200

{
    "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
    "name": "My set",
    "indicators": [
        "leads.accepted",
        "leads.assigned"
    ]
}

Update indicator set

PUT reports/indicator-sets/:indicator_set_id

Parameters

Uses same parameters as Create indicator set

Payload

{
    "name": "My new set name",
    "indicators": [
        "leads.accepted",
        "leads.assigned",
        "contacts.b2c.created"
    ]
}

Response

Status Code 200

{
    "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
    "name": "My new set name",
    "indicators": [
        "contacts.b2c.created",
        "leads.accepted",
        "leads.assigned"
    ]
}

Delete indicator set

DELETE reports/indicator-sets/:indicator_set_id

Response
Status code 204

Report export

Create new export

GET reports/export

Query string parameters

activity_type_ids UUID - Comma separated list of ids
created_from_lead boolean
group_by string
- one of activity_type, company, group, lead_source, lead_type, relations_path, team, user
- default value: user
group_ids string - Comma separated list of ids
indicators string - Comma separated list of indicators
- Required
lead_sources string - Comma separated list
lead_type_ids UUID - Comma separated list of ids
product_ids UUID - Comma separated list of ids
relations_path_ids UUID - Comma separated list of ids
start_at date
- Y-m-d H:i:s format
end_at date
- Y-m-d H:i:s format
team_ids integer - Comma separated list of ids
user_ids integer - Comma separated list of ids

Response

{
    "export_id": "b795b892-d6e0-4d4c-8f0f-9a10ee035f81",
    "file_id": null,
    "status": null
}

Get export status

GET reports/export/:export_id

Parameters

id UUID

Response

{
    "export_id": "b795b892-d6e0-4d4c-8f0f-9a10ee035f81",
    "file_id": "e2d814a4-6dc4-4000-8f14-c5c9e452ca14",
    "status": "done"
}

Scheduled reports

Get scheduled reports list

GET reports/scheduled

Query string parameters

per_page integer
page integer
indicator_set_id UUID

Response
Status Code 200

{
    "data": [
        {
            "id": "2daec72f-a824-40b5-b2ef-52c04b922ed8",
            "indicator_set": {
                "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
                "name": "My new set name"
            },
            "name": "leads monthly",
            "recipients_count": 2,
            "delivery_frequency": "month",
            "next_delivery": "2019-02-01",
            "created_at": "2019-01-24 14:32:34",
            "updated_at": "2019-01-24 14:32:34"
        }
    ],
    "pagination": {
        "total": 1,
        "page": 1,
        "per_page": 15,
        "urls": {
            "previous": null,
            "next": null
        }
    }
}

Get scheduled report

GET reports/scheduled/:scheduled_report_id

Response

Status Code 200

{
    "id": "2daec72f-a824-40b5-b2ef-52c04b922ed8",
    "indicator_set": {
        "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
        "name": "My new set name"
    },
    "name": "leads monthly",
    "filters": {
        "relations_paths": null,
        "lead_sources": null,
        "lead_types": null,
        "groups": null,
        "teams": null
    },
    "recipients": [
        {
            "id": 1,
            "first_name": "Jane",
            "last_name": "Doe",
            "phone_number": "+4588888888",
            "job_title": "Sales Executive",
            "email": "jane@example.com",
            "email_notifications": false,
            "profile_picture": null,
            "system_user": false,
            "created_at": "2014-01-01 12:45:56",
            "updated_at": "2014-01-02 00:11:22"
        },
        {
            "id": 8,
            "first_name": "Maegan",
            "last_name": "Weber",
            "phone_number": "746-831-5137",
            "job_title": "Data Scientist - User Analysis",
            "email": "maegan@example.com",
            "email_notifications": false,
            "profile_picture": null,
            "system_user": false,
            "created_at": "2018-08-20 18:46:48",
            "updated_at": "2019-01-21 12:05:05"
        }
    ],
    "recipients_count": 2,
    "delivery_frequency": "month",
    "next_delivery": "2019-02-01",
    "created_at": "2019-01-24 14:32:34",
    "updated_at": "2019-01-24 14:32:34"
}

Create scheduled report

POST reports/scheduled

Parameters

name string
- required
indicator_set_id UUID
- required
delivery_frequency string
- required
- one of: day, week, month, quarter, year
recipient_user_ids array *required
- recipient_user_ids.* integer
filters object
- filters.relation_path_ids array
  - filters.relation_path_ids.* UUID
- filters.lead_type_ids array
  - filters.lead_type_ids.* UUID
- filters.lead_sources array
  - filters.lead_sources.* string
- filters.group_ids array
  - Admin only
  - filters.group_ids.* integer
- filters.team_ids array
  - Admin or Group Admin only
  - filters.team_ids.* integer

Payload

{
    "name": "leads monthly",
    "indicator_set_id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
    "delivery_frequency": "month",
    "recipient_user_ids": [1, 8]
}

Response
Status Code 200

{
    "id": "2daec72f-a824-40b5-b2ef-52c04b922ed8",
    "indicator_set": {
        "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
        "name": "My new set name"
    },
    "name": "leads monthly",
    "filters": {
        "relations_paths": null,
        "lead_sources": null,
        "lead_types": null,
        "groups": null,
        "teams": null
    },
    "recipients": [
        {
            "id": 1,
            "first_name": "Jane",
            "last_name": "Doe",
            "phone_number": "+4588888888",
            "job_title": "Sales Executive",
            "email": "jane@example.com",
            "email_notifications": false,
            "profile_picture": null,
            "system_user": false,
            "created_at": "2014-01-01 12:45:56",
            "updated_at": "2014-01-02 00:11:22"
        },
        {
            "id": 8,
            "first_name": "Maegan",
            "last_name": "Weber",
            "phone_number": "746-831-5137",
            "job_title": "Data Scientist - User Analysis",
            "email": "maegan@example.com",
            "email_notifications": false,
            "profile_picture": null,
            "system_user": false,
            "created_at": "2018-08-20 18:46:48",
            "updated_at": "2019-01-21 12:05:05"
        }
    ],
    "recipients_count": 2,
    "delivery_frequency": "month",
    "next_delivery": "2019-02-01",
    "created_at": "2019-01-24 14:32:34",
    "updated_at": "2019-01-24 14:32:34"
}

Update scheduled report

PUT reports/scheduled/:scheduled_report_id

Parameters

Uses same parameters as Create scheduled report

Payload

{
    "name": "leads yearly",
    "indicator_set_id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
    "delivery_frequency": "year",
    "recipient_user_ids": [1, 8, 12]
}

Response
Status Code 200

{
    "id": "2daec72f-a824-40b5-b2ef-52c04b922ed8",
    "indicator_set": {
        "id": "87f41a74-97db-4671-ba29-2b8fee49c47c",
        "name": "My new set name"
    },
    "name": "leads yearly",
    "filters": {
        "relations_paths": null,
        "lead_sources": null,
        "lead_types": null,
        "groups": null,
        "teams": null
    },
    "recipients": [
        {
            "id": 1,
            "first_name": "Jane",
            "last_name": "Doe",
            "phone_number": "+4588888888",
            "job_title": "Sales Executive",
            "email": "jane@example.com",
            "email_notifications": false,
            "profile_picture": null,
            "system_user": false,
            "created_at": "2014-01-01 12:45:56",
            "updated_at": "2014-01-02 00:11:22"
        },
        {
            "id": 8,
            "first_name": "Maegan",
            "last_name": "Weber",
            "phone_number": "746-831-5137",
            "job_title": "Data Scientist - User Analysis",
            "email": "maegan@example.com",
            "email_notifications": false,
            "profile_picture": null,
            "system_user": false,
            "created_at": "2018-08-20 18:46:48",
            "updated_at": "2019-01-21 12:05:05"
        },
        {
            "id": 12,
            "first_name": "John",
            "last_name": "Brown",
            "phone_number": "741-822-5155",
            "job_title": "Data Scientist - User Analysis",
            "email": "john@example.com",
            "email_notifications": false,
            "profile_picture": null,
            "system_user": false,
            "created_at": "2018-10-20 18:46:48",
            "updated_at": "2019-01-19 12:05:05"
        }
    ],
    "recipients_count": 3,
    "delivery_frequency": "year",
    "next_delivery": "2020-01-01",
    "created_at": "2019-01-24 14:32:34",
    "updated_at": "2019-01-24 14:32:34"
}

Delete scheduled report

DELETE reports/scheduled/:scheduled_report_id

Response
Status code 204