• 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 Attribution

Introduction

The attribution section of the report API allows you to read the active attribution models that have been set for the given IGRP.

List Attribution Models

Returns a list of all attribution models that are active for the given IGRP.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/attribution

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

GET Params

• filter (array) OPTIONAL - One or more filters.
• sort (array) OPTIONAL - One or more sorting params.
• limit (integer) OPTIONAL - Limit on the result set.
• offset (integer) OPTIONAL - Offset on the result set.

Filter Types

• modelId (int) - Attribution model ID.
• igrp (int) - Installation ID.
• modelName (string) - Attribution model description.
• modelType (string) - Attribution model reference.
• modelStatus (int) - Attribution model status.

Sort Types

Same as Filter Types

Response:

All active attribution models for the given IGRP spec.

• modelId (int) - Attribution model ID.
• igrp (int) - Installation ID.
• modelName (string) - Attribution model description.
• modelType (string) - Attribution model reference.
• matchCriteria (json) - Matching criteria configuration.
• lookbackDays (int) - Lookback time in days.
• modelStatus (int) - Attribution model status.
• createDatetime (string) - Date and time when the Attribution model was created.
• updateDatetime (string) - Date and time when the Attribution model was last updated.
• deleteDatetime (string) - Date and time when the Attribution model was deleted.
• weight (int) OPTIONAL - The assigned weight for the type of model.
• channelsMode (string) OPTIONAL - Config for exluding or including particular channels. Valid values are “exclude” and “include”.
• channels (array) OPTIONAL - List of channel IDs for inclusion or exclusion.
• firstWeight (int) OPTIONAL - First weighting for the attribution model.
• lastWeight (int) OPTIONAL - Last weighting for the attribution model.

{"modelId":"1","igrp":"1","modelName":"Weighted First (exc. PPC)","modelType":"weightedFirst","lookbackDays":30,"weight":4,"channels":[1],"channelsMode":"exclude","matchCriteria":"","modelStatus":"200","createDatetime":"2016-12-01 14:05:57","updateDatetime":"2016-12-02 14:05:57","deleteDatetime":"0000-00-00 00:00:00"}
{"modelId":"2","igrp":"1","modelName":"Bath Tub","modelType":"spread","lookbackDays":90,"firstWeight":2,"lastWeight":3,"channels":[1],"channelsMode":"exclude","matchCriteria":"","modelStatus":"200","createDatetime":"2016-12-01 14:05:57","updateDatetime":"2016-12-02 14:05:57","deleteDatetime":"0000-00-00 00:00:00"}

Read Attribution Model

Returns a single row attribution model for the given IGRP ID and attribution model ID.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/attribution/{ATTRIBUTION SPECIFIER}

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• ATTRIBUTION SPECIFIER (int) - Attribution model ID.

Response:

Single row of the attribution model details.

• modelId (int) - Attribution model ID.
• igrp (int) - Installation ID.
• modelName (string) - Attribution model description.
• modelType (string) - Attribution model reference.
• matchCriteria (json) - Matching criteria configuration.
• lookbackDays (int) - Lookback time in days.
• modelStatus (int) - Attribution model status.
• createDatetime (string) - Date and time when the Attribution model was created.
• updateDatetime (string) - Date and time when the Attribution model was last updated.
• deleteDatetime (string) - Date and time when the Attribution model was deleted.
• weight (int) OPTIONAL - The assigned weight for the type of model.
• channelsMode (string) OPTIONAL - Config for exluding or including particular channels. Valid values are “exclude” and “include”.
• channels (array) OPTIONAL - List of channel IDs for inclusion or exclusion.
• firstWeight (int) OPTIONAL - First weighting for the attribution model.
• lastWeight (int) OPTIONAL - Last weighting for the attribution model.

{"modelId":"1","igrp":"1","modelName":"Weighted First (exc. PPC)","modelType":"weightedFirst","lookbackDays":30,"weight":4,"channels":[1],"channelsMode":"exclude","matchCriteria":"","modelStatus":"200","createDatetime":"2016-12-01 14:05:57","updateDatetime":"2016-12-02 14:05:57","deleteDatetime":"0000-00-00 00:00:00"}