Welcome‎ > ‎Version 3‎ > ‎Broadcast Api (Read Only)‎ > ‎Methods‎ > ‎

Get Broadcast Segments

Segments are publisher-defined.  A segment may be a city that a publisher is in, or any other subset of a publisher's audience.  Examples of segments could be los angeles, kids, or golf-lovers.  This broadcast method gets the list of all active and coming-soon segments.

Method: GET /api/v3/publisher/broadcast/segments?ApiKey={apiKey}

Authentication: apiKey

Parameters
Required QueryString Value
Explanation
Yes
ApiKey
The publisher specific public api key.
 
Returns
base response fields
segments - A list of broadcast segments.


Sample Request:

GET https://api.groupcommerce.com/api/v3/publisher/broadcast/segments?ApiKey=eeb6b959-b854-4ad1-b563-e801c83cf81d


Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1324594432424)/",
    "success": true,
    "version": "3",
    "metaData": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 2,
        "totalItems": 2
    },
    "segments": [
        {
            /* see Broadcast Segment */
        },
        {
            /* see
Broadcast Segment */
        }
    ]
}


Sample XML Response:

<getSegmentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <errors/>
    <lastPublished>2011-12-22T22:56:35.6526414Z</lastPublished>
    <success>true</success>
    <version>3</version>
    <metaData>
        <pageCount>1</pageCount>
        <pageNumber>1</pageNumber>
        <pageSize>2</pageSize>
        <totalItems>2</totalItems>
    </metaData>
    <segments>
        <segment>
           
<!-- see Broadcast Segment -->
        </segment>
        <segment>
            <!-- see Broadcast Segment -->
        </segment>
    </segments>
</getSegmentsResponse>

Comments