Reports API Version 2 Segments

Introduction

A Segment is a concept that can be used to group triggers based on specific business logic (as opposed to channels, which group triggers by marketing source).

Segment Properties

These are the properties that can be accessed using the API.

List Segments

Lists the Segments for an IGRP.

Request:

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

URL Path Params

GET Params

Filter Types

The Segments list may be filtered by any of the returned fields.

Sort Types

The Segments list may be sorted by any of the returned fields.

Response:

HTTP 200 - OK

Read Segment Config

Returns the properties for a particular Segment.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/segments/{SEGMENT SPECIFIER}

URL Path Params

Response:

HTTP 200 - OK

Segment Groups

Introduction

A Segment Group is a concept that can be used to group segmented data for reports. Each segment may belong to only one Segment Group at a time.

Every trigger will be stamped with a segmentGroupId that will allow historical reporting of which triggers were in which Segment Group.

Segment Group Properties

These are the properties that can be accessed using the API.

List Segment Groups

Lists the Segment Groups for an IGRP.

Request:

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

Segment Group Params

GET Params

Filter Types

The Segment Groups list may be filtered by any of the Segment Group Properties.

Sort Types

The Segment Groups list may be sorted by any of the Segment Group Properties.

Response:

Returns a list of Segment Groups that the user can access, including the Segment Group Properties described above.

Returns the HTTP response 200.

{"segmentGroupId":"400","segmentGroupName":"Segment Group Name 400","igrp":"1","segmentGroupStatus":"200"}
{"segmentGroupId":"401","segmentGroupName":"Segment Group Name 401","igrp":"1","segmentGroupStatus":"200"}

Read Segment Config

Returns the Segment Group Properties for a particular Segment Group.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/segmentGroups/{SEGMENT GROUP SPECIFIER}

Segment Group Params

Response:

Returns the HTTP response 200.

{"segmentGroupId":"400","segmentGroupName":"Segment Group Name 400","igrp":"1","segmentGroupStatus":"200"}