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

Get Broadcast Offers

This broadcast method will get all offers for the publisher based on a set of filtering parameters.

Method: GET /api/v3/publisher/broadcast/offers?pagenumber={pageNumber}&pagesize={pageSize}&startDate={startDate}&endDate={endDate}&OrderBy={orderBy}&segmentKeys={segmentKeys}&ClassificationKeys={classificationKeys}&Tags={tags}&ApiKey={apiKey}

Authentication: apiKey
 
Parameters
Required QueryString Value
Explanation
Yes
ApiKey
The publisher specific public api key.
No
PageSize
The number of records to return per page. Default is 100
No
PageNumber The page number of records to return. Default is 1
No
StartDate
The date range to filter against the start date of the offer.
NoEndDateThe date range to filter against the end date of the offer.
NoOrderByThe columns the records should be sorted on and the direction of the sort, specified as a comma separated list.  e.g. the value "startdate asc, offerid desc" orders by startdate ascending, and then by offerid descending.  Currently supported values: startdate, enddate, and/or offerid with asc or desc.
NoSegmentKeysThe segment keys filter to apply against the offer segment key, specified as a comma separated list.  e.g. "ny,sea,mia"
NoClassificationKeysThe classification keys filter to apply against the offer classification keys, specified as a comma separated list.  e.g. "auto,autorepair,carwash"
NoTagsThe tags filter to apply against the offer tags, specified as a comma separated list.  e.g. "sports,basketball,training"

Returns
base response fields
offers - Will return a list of Broadcast Offers.

Sample Request:

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

Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1324593713631)/",
    "success": true,
    "version": "3",
    "metaData": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 2
    },
    "offers": [
        { /* see Broadcast Offer */},
        {
/* see Broadcast Offer */ }
    ]
}


Sample XML Response:

<getBroadcastOffersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <errors/>
  <lastPublished>2011-11-29T22:59:59.3406803Z</lastPublished>
  <success>true</success>
  <version>3</version>
  <metaData>
    <pageCount>1</pageCount>
    <pageNumber>1</pageNumber>
    <pageSize>10</pageSize>
    <totalItems>2</totalItems>
  </metaData>
  <offers>
    <offer>
        
<!-- see Broadcast Offer -->
    </offer>
    <offer>
       
<!-- see Broadcast Offer -->
    </offer>
  </offers>
</getBroadcastOffersResponse>

Comments