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

site object

The site object represents a collection of ad unitThe smallest inventory component that represents the space on a site where ads display. inventoryAd space available on a website or app. The basic unit of inventory for OpenX is an ad unit.. It has the following calls:

Call Description
DELETE /site Delete the specified sites.
DELETE /site/site_UID Delete the specified siteAn OpenX component that represents top-level domains or sub-domains and is used to organize ad units. Sites enable you to target and report on inventory performance..
GET /site List all sites.
GET /site/available_fields?account_uid=publisher_account_UID List the available fields to create or update a site for the specified publisherAn account type that represents a business with ad space to sell. account.
GET /site/list_ad_tags List ad tags and other information for the specified sites.

Parameters:

site_uids(Required) A comma-separated string of site UIDs
format(Optional) Set format=txt to export ad tags in a text file
GET /site/performance/site_UID Get performance metrics for the specified site 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 /site/site_UID Read the specified site.
GET /site/site_UID/list_ad_unit_groups List ad unit groups for the specified site.
GET /site/site_UID/list_ad_units List ad units for the specified site.
GET /site/site_UID/list_site_sections List sections of the specified site.
POST /site Create a site.
POST /site/list_ad_tags List ad tags and other information for the specified sites.

Parameters:

site_uids(Required) A comma-separated string of site UIDs
format(Optional) Set format=txt to export ad tags in a text file
POST /site/site_UID/clone Clone the specified site.
POST /site/upload_icon Upload an icon for the specified site.
PUT /site Update the specified sites.
PUT /site/site_UID Update the specified site.

See also

Creating a site.

Feedback form