You are here: Developers > OpenX Platform API > Platform API reference > audiencesegment object

audiencesegment object

An inventoryAd space available on a website or app. The basic unit of inventory for OpenX is an ad unit. object that represents a group of users with similar traits or characteristics

The audiencesegment object has the following calls:

Call Description
DELETE /audiencesegment Delete the specified audience segments.
DELETE /audiencesegment/audience_segment_UID Delete the specified audience segmentA group of users with similar traits or characteristics..
GET /audiencesegment List all audience segments.
GET /audiencesegment/audience_segment_UID Read the specified audience segment.
GET /audiencesegment/audience_segment_UID/generate_tag. Generate the HTML tag for the audience segment.
GET /audiencesegment/available_fields List the available fields to create or update an audience segment.
GET /audiencesegment/performance/audience_segment_UID Get the performance metrics for the specified audience segment within the (optional) date range.

Parameters

  • start_date

    • A specific date in yyyy-mm-dd HH:MM:SS format

      OR

    • An integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

  • end_date

    • A specific date in yyyy-mm-dd HH:MM:SS format

      OR

    • A negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

GET /audiencesegment/reach_performance/audience_segment_UID. List the reach performance data for the specified audience segment.
GET /audiencesegment/revenue_performance/audience_segment_UID. List the revenue performance data for the specified audience segment.
POST /audiencesegment Create one or more audience segments.
POST /audiencesegment/audience_segment_UID/clone Clone the specified audience segment.
PUT /audiencesegment Update the specified audience segments.
PUT /audiencesegment/audience_segment_UID Update the specified audience segment.

See also

Audience segments in the OpenX UI help.

Feedback form