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

Get Broadcast Segment Listings

A member of the publisher's production team can rank or order items within a segment using the pub admin application.  This method will return a list of SegmentListing objects that will contain either an Offer or a Segment ordered as specified in pub admin.

Method: GET /api/v3/publisher/broadcast/segmentlistings/{segmentKey}
Authentication: oauth

Required Parameters
base response fields
segmentKey - the segment key of the segment whose offers and child segments will be returned.

Parameters
Required QueryString Value
Explanation
No
PageSize
The number of records to return per page. Default is 10
No
PageNumber The page number of records to return. Default is 1

Returns
segmentListings - Will return a list of Broadcast Segment Listings

Sample Request:

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

Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1340379289986)/",
    "success": true,
    "version": "3",
    "metaData": {
        "pageCount": 2,
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 11
    },
    "segmentListings": [
        {
            // see broadcast segment listing
        },
       
{
           
// see broadcast segment listing
        }
    ]
}


Sample XML Response:

<getBroadcastSegmentListingsResponse>
    <errors/>
    <lastPublished>2012-06-22T15:38:20.4205013Z</lastPublished>
    <success>true</success>
    <version>3</version>
    <metaData>
        <pageCount>2</pageCount>
        <pageNumber>1</pageNumber>
        <pageSize>10</pageSize>
        <totalItems>11</totalItems>
    </metaData>
    <segmentListings>
        <segmentListing>
            <!--
see broadcast segment listing -->
        </segmentListing>
       
<segmentListing>
           
<!-- see broadcast segment listing -->
        </segmentListing>

    </segmentListings>
</getBroadcastSegmentListingsResponse>
Comments