GET /incentives/incentive/{id}

Updated on
 
Request an incentiveItem by its ID. See incentiveItem element definition in WSDL/XSD
This resource does not require a signed request, only a connect ID. See Authentication documentation for REST and SOAP. Passing connectid as query parameter in REST is supported.

Notes

Please see GET Incentives for an overview of the incentives resource.

Resource URL

XML:   http://api.zanox.com/xml/2011-03-01/incentives/incentive/{id}
JSON: http://api.zanox.com/json/2011-03-01/incentives/incentive/{id}

Parameters

incentive
required

The ID of the incentive.

Value Type: Integer incentive ID.
Example Value123

adspace
optional

Only return tracking links for this ad space.

Value Type: Integer adspace ID.
Example Value

Example Request

Example Response

<GetIncentiveResponse xmlns="http://api.zanox.com/namespace/2011-03-01/">
    <incentiveItem id="633548">
        <name>Test Incentive</name>
        <program id="10917">TEST RND Program 1</program>
        <admedia>
            <admediumItem id="181368">
                <name>Alba Moda - anziehend italienisch</name>
                <adrank>0.0</adrank>
                <admediumType>text</admediumType>
                <program id="3782">Alba Moda DE</program>
                <title>Alba Moda - anziehend italienisch</title>
                <code/>
                <category id="16384">Textlinks</category>
                <trackingLinks>
                    <trackingLink adspaceId="1187906">
                        <ppv>
                            http://ad.zanox.com/ppv/?15222588C52080378&zpar9=[[580599047DF8F5311043]]
                        </ppv>
                        <ppc>
                            http://ad.zanox.com/ppc/?15222588C52080378&zpar9=[[580599047DF8F5311043]]
                        </ppc>
                    </trackingLink>
                </trackingLinks>
            </admediumItem>
        </admedia>
        <incentiveType>coupons</incentiveType>
        <regions>
            <region>DE</region>
        </regions>
        <createDate>2015-02-09T17:04:51.640+01:00</createDate>
        <modifiedDate>2015-02-09T17:07:10.853+01:00</modifiedDate>
        <startDate>2015-02-10T00:00:00+01:00</startDate>
        <endDate>2999-02-10T00:00:00+01:00</endDate>
        <info4publisher>Test Incentive.</info4publisher>
        <info4customer>Test Incentive</info4customer>
        <newCustomerOnly>false</newCustomerOnly>
        <prizes/>
    </incentiveItem>
</GetIncentiveResponse>

 

Resource Information

Rate Limited? No
Authentication Requires connect ID. See
REST Authentication
SOAP Authentication
Response Formats json, xml
HTTP Methods GET
Resource family Incentives
Response Object incentiveItem
API Version 2011-03-01