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

account object

A business unit or business relationship as it is represented in OpenX, such as an ad networkAn OpenX account type, which represents a business that manages other businesses and typically contains and manages both publisher accounts and advertiser accounts., advertiserIn OpenX, an account type that represents a business that runs advertising campaigns to display ads on websites., publisherAn account type that represents a business with ad space to sell., or agency

The account object has the following calls:

Call

Description

GET /account

List all accounts.

GET /account/account_UID

Read the specified account.

GET /account/account_UID/default_market

Retrieve market information from the parent account.

GET /account/account_UID/generate_cookie_mapping_url_template

Retrieve data for the cookie-mapping URL form (used by the OpenX UI).

GET /account/account_UID/generate_rtb_data_url_template

Retrieve data for the Real-Time Bid Settings form (used by the OpenX UI).

GET /account/account_UID/lifetime_budget_remaining

Retrieve payments-to-date minus lifetime-spending-to-date for the specified account.

GET /account/account_UID/list_accounts

List sub-accounts for the specified account.

GET /account/account_UID/list_audience_segments

List audience segments for the specified account.

GET /account/account_UID/list_competitive_exclusions

List competitive exclusions for the specified account.

GET /account/account_UID/list_conversion_tags

List conversion tags for the specified account.

GET /account/account_UID/list_creatives

List creatives for the specified account.

GET /account/account_UID/list_orders

List orders for the specified account.

GET /account/account_UID/list_packages

List packages for the specified account.

GET /account/account_UID/list_payment_history

List payment history for the specified account.

GET /account/account_UID/list_sites

List sites for the specified account.

GET /account/account_UID/list_users

List users for the specified account.

GET /account/account_UID/monthly_budget_remaining

  • For Ad Exchange accounts without payments, return the monthly budget minus monthly spending.

  • For Ad Exchange accounts with payments, return a number calculated based on lifetime payment, lifetime spending, monthly spending to date, and monthly budget.

  • Otherwise, return 0.

GET /account/account_UID/payments_to_date

Return the sum of all payments up to the current date for the specified account.

GET /account/all_unlinked_lift_accounts

List all accounts that are not data-linked advertisers.

GET /account/available_fieldstype_full=account.type

Open account object example 1

List the available fields to create or update an account of the specified type.

GET /account/check_ssrtb_endpoint

Validate server-side real-time bidding (SSRTB) endpoints.

GET /account/performance/account_UID

Get the performance metrics for the specified account 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 /account/unlinked_lift_accounts

List advertiser accounts (without third-party network) and Ad Exchange advertiser accounts (with or without third-party network).

POST /account

Open account object example 2

Create one or more accounts.

POST /account/account_UID/clone

Create a copy of the specified account.

PUT /account

Update the specified accounts.

PUT /accountaccount_UID

Update the specified account.

See also

Feedback form