We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience
Audience
Breadcrumbs

User Segment Targeting API

This API exposes operations to allow management of User Segment Targeting features on Campaigns and Ads within the Cxense Advertising platform.

Please note: To be able to create and update User Segment Targeting features, you need to have configured Cxense Analytics integration within Cxense Advertising.

Values inside the <cx:userSegment> tags need to be valid user segment ids provided by Cxense Analytics.

This API can be accessed by Advertisers and supports the following combination of operations on User Segment Targeting feature domain objects:

Object

Supported operations

User Segment Targeting feature list

GET

User Segment Targeting feature

POST, GET, PUT and DELETE

Retrieving list of User Segment Targeting features for a Campaign or Ad

The GET operation is supported for listing existing User Segment Targeting features.

GET

Retrieve all of the User Segment Targeting features saved at or below the Campaign or Ad with the given parentId. One call using the id of a Campaign will return all User Segment Targeting features stored against the Campaign and its Ads in a single response.

https://{cxadbaseurl}/api/secure/userSegmentFeatures/{parentId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • parentId the id of either a Campaign or Ad for which the User Segment Targeting features are to be retrieved

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X GET https://cxad.cxense.com/api/secure/userSegmentFeatures/0000000000039355

 

This XML example shows the contents returned from a GET call:

<?xml version="1.0" encoding="UTF-8"?>
<cx:userSegmentFeatures xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:userSegmentFeature>
        <cx:featureId>0000000000002dc8</cx:featureId>
        <cx:templateId>0000000000002db9</cx:templateId>
        <cx:userSegment>123456</cx:userSegment>
        <cx:userSegment>123457</cx:userSegment>
    </cx:userSegmentFeature>
    <cx:userSegmentFeature>
        <cx:featureId>0000000000004ed9</cx:featureId>
        <cx:templateId>0000000000003ec0</cx:templateId>
        <cx:userSegment>123458</cx:userSegment>
        <cx:userSegment>123459</cx:userSegment>
    </cx:userSegmentFeature>
</cx:userSegmentFeatures>

 

Individual User Segment Targeting features

The POST, GET, PUT and DELETE operations are supported for management of individual User Segment Targeting features.

POST

Create a new User Segment Targeting feature under the Campaign or Ad with the given parentId.

https://{cxadbaseurl}/api/secure/userSegmentFeature/{parentId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • parentId the id of either a Campaign or Ad under which the new User Segment Targeting feature is to be created

This XML example shows the contents required to be supplied for a POST call:

<?xml version="1.0" encoding="UTF-8"?>
<cx:userSegmentFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:templateId>0000000000002db9</cx:templateId>
    <cx:userSegment>123456</cx:userSegment>
    <cx:userSegment>123457</cx:userSegment>
</cx:userSegmentFeature>

 

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X POST https://cxad.cxense.com/api/secure/userSegmentFeature/0000000000093906 -d @input.xml

GET

Retrieve the User Segment Targeting feature with the given featureId

https://{cxadbaseurl}/api/secure/userSegmentFeature/{featureId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the User Segment Targeting feature to be retrieved

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X GET https://cxad.cxense.com/api/secure/userSegmentFeature/00000000000353gg

This XML example shows the contents returned from a GET call:

<?xml version="1.0" encoding="UTF-8"?>
<cx:userSegmentFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:featureId>0000000000002dc8</cx:featureId>
    <cx:templateId>0000000000002db9</cx:templateId>
    <cx:userSegment>123456</cx:userSegment>
    <cx:userSegment>123457</cx:userSegment>
</cx:userSegmentFeature>


PUT

Update the User Segment Targeting feature with the given featureId

https://{cxadbaseurl}/api/secure/userSegmentFeature/{featureId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the User Segment Targeting feature to be updated

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X PUT https://cxad.cxense.com/api/secure/userSegmentFeature/00000000000353gg -d @input.xml

This XML example shows the contents required to be supplied for a PUT call:

<?xml version="1.0" encoding="UTF-8"?>
<cx:userSegmentFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
    <cx:userSegment>123458</cx:userSegment>
    <cx:userSegment>123459</cx:userSegment>
</cx:userSegmentFeature>

 

DELETE

Delete the User Segment Targeting feature with the given featureId

https://{cxadbaseurl}/api/secure/userSegmentFeature/{featureId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the User Segment Targeting feature to be deleted

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X DELETE https://cxad.cxense.com/api/secure/userSegmentFeature/00000000000353gg


Last updated: