• Home
• Config V2 Basics
• Config V2 Organisations
• Config V2 Organisation Types
• Config V2 Channels
• Config V2 Installation Groups
• Config V2 Report Schedule Subscribers
• Config V2 Segments
• Config V2 Dial-In Groups
• Config V2 Goals
• Config V2 Goal Groups
• Config V2 Numbers
• Config V2 Custom
• Config V2 Profile
• Config V2 Users
• Config V2 Roles
• Config V2 Visitor Types
• Config V2 Attribution
• Config V2 SIP Phone System
• Config V2 Notifications
• Config V2 Dialplans
• Config V2 Integrations
• Config V2 PPC
• Config V2 DGRP maps
• Config V2 DGRP map items
• Config V2 IGRP Caller Blocks
• Config V2 Caller Insight
• Config V2 Caller Insight for Salesforce
• Config V2 Call Rating
• Config V2 Custom Vocabulary
• Reports V2 Basics
• Reports V2 Installation Groups
• Reports V2 Dial-In Groups
• Reports V2 Triggers
• Reports V2 Triggers (Deprecated)

• Reports V2 Custom

• Reports V2 Metrics
• Reports V2 Call Rating
• Reports V2 Channels
• Reports V2 Organisations
• Reports V2 Organisation Types
• Reports V2 Segments
• Reports V2 Visitors
• Reports V2 Attribution
• Reports V2 Audit
• Reports V2 Currencies
• Reports V2 Goals
• Reports V2 Real Time
• Reports V2 PBX triggers
• Export V2 Invoices
• Event API Basics
• Event API Example
• Event FTP Upload
• Call Events
• Salesforce Events
• Config V2 Oauth2
• Config V2 Scheduled Reports
• Reports V2 PPC
• Config V2 Keyword Spotting
• Reports V2 Call Keywords

Reports API Version 2 Custom

Introduction

The custom section of the report API allows you to run custom reports that are defined for an IGRP.

Run Custom Report

Runs a custom report.

Request:

GET /reports/v2/custom

GET Params

• igrp (int) - IGRP to get metrics for.
• reportId (int) - IGRP to get metrics for.
• sort (array) OPTIONAL - One or more sorts, see Sort Types.
• group (array) OPTIONAL - One or more groups, see Group Types.
• filter (array) OPTIONAL - One or more filters, see Filter Types.
• limit (int) OPTIONAL - Limit result set, see Pagination.
• offset (int) OPTIONAL - Offset result set, see Pagination.

Each custom report may define its own extra parameters. These are detailed in the config API custom reports list.

Filter Types

These are defined differently for each custom report. These are detailed in the config API custom reports list.

Group Types

These are defined differently for each custom report. These are detailed in the config API custom reports list.

Sort Types

These are defined differently for each custom report. These are detailed in the config API custom reports list.

Response:

Returns the result of the specified custom report.