Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Advertisers

Get Advertiser by ID

get/networks/advertisers/{advertiserId}

Path parameters

advertiserIdinteger required

The unique advertiser ID.

Query parameters

relationship'reporting' | 'labels' | 'demand_partner' | 'billing' | 'integrations' | 'api' | 'settings' | 'product_feed' | 'deal'

Include related data in the response. Available relationships:

  • reporting — Includes reporting information (clicks, conversions, revenue, etc.)
  • labels — Includes a list of labels associated to the advertiser
  • demand_partner — Includes the Everxchange information associated to the advertiser
  • billing — Includes the billing information associated to the advertiser
  • integrations — Includes the integration settings associated to the advertiser
  • api — Includes the advertiser's API keys and whitelisted IPs
  • settings — Includes the advertiser's settings (exposed variables)
  • product_feed — Includes product feeds configured for this advertiser
  • deal — Includes deals configured for this advertiser

Response

network_advertiser_idinteger

Unique advertiser ID.

network_idinteger

Network ID.

namestring

Advertiser name.

account_status'active' | 'inactive' | 'pending' | 'suspended'

Current account status.

network_employee_idinteger

Account manager employee ID.

sales_manager_idinteger

Sales manager employee ID.

internal_notesstring

Private notes visible only to network users.

default_currency_idstring

ISO currency code for the advertiser's default currency (e.g. "USD").

platform_namestring

Shopping cart or attribution platform name (e.g. Shopify, Adjust).

platform_urlstring

URL for logging into the advertiser's platform.

platform_usernamestring

Username for the advertiser's platform.

reporting_timezone_idinteger

Timezone ID used for this advertiser's reporting.

attribution_method'first_touch' | 'last_touch'

Click attribution method.

email_attribution_method'last_affiliate_attribution' | 'first_affiliate_attribution'

Email-based attribution method.

attribution_priority'click' | 'coupon_code'

Whether clicks or coupon codes take priority for attribution.

accounting_contact_emailstring

Email address for accounting/billing contact.

verification_tokenstring

Verification token for postback security (max 50 alphanumeric characters).

offer_id_macrostring

Offer ID parameter name for Direct Linking.

affiliate_id_macrostring

Partner ID parameter name for Direct Linking.

address_idinteger

Address record ID.

is_contact_address_enabledboolean

Whether a contact address is stored for this advertiser.

is_expose_publisher_reporting_databoolean nullable

Whether publisher reporting data is exposed to this advertiser.

labelsstring[]

Labels to assign. Only used in create/update requests. Use the relationship object to read labels.

time_createdinteger

Unix timestamp when the advertiser was created.

time_savedinteger

Unix timestamp when the advertiser was last updated.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "users": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "api_keys": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "product_feeds": [
      {
        "time_saved": 1734455015,
        "time_created": 1734455015
      }
    ]
  }
}