Skip to main content
GET
Get Advertiser by ID
Retrieve a single advertiser by its ID. Use the relationship query parameter to include related data. Repeat the parameter for multiple relationships (e.g. ?relationship=labels&relationship=billing).

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Path Parameters

advertiserId
integer
required

The unique advertiser ID.

Query Parameters

relationship
enum<string>

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
Available options:
reporting,
labels,
demand_partner,
billing,
integrations,
api,
settings,
product_feed,
deal

Response

network_advertiser_id
integer

Unique advertiser ID.

network_id
integer

Network ID.

name
string

Advertiser name.

account_status
enum<string>

Current account status.

Available options:
active,
inactive,
pending,
suspended
network_employee_id
integer

Account manager employee ID.

sales_manager_id
integer

Sales manager employee ID.

internal_notes
string

Private notes visible only to network users.

default_currency_id
string

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

platform_name
string

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

platform_url
string

URL for logging into the advertiser's platform.

platform_username
string

Username for the advertiser's platform.

reporting_timezone_id
integer

Timezone ID used for this advertiser's reporting.

attribution_method
enum<string>

Click attribution method.

Available options:
first_touch,
last_touch
email_attribution_method
enum<string>

Email-based attribution method.

Available options:
last_affiliate_attribution,
first_affiliate_attribution
attribution_priority
enum<string>

Whether clicks or coupon codes take priority for attribution.

Available options:
click,
coupon_code
accounting_contact_email
string

Email address for accounting/billing contact.

verification_token
string

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

offer_id_macro
string

Offer ID parameter name for Direct Linking.

affiliate_id_macro
string

Partner ID parameter name for Direct Linking.

address_id
integer

Address record ID.

is_contact_address_enabled
boolean

Whether a contact address is stored for this advertiser.

is_expose_publisher_reporting_data
boolean | null

Whether publisher reporting data is exposed to this advertiser.

time_created
integer

Unix timestamp when the advertiser was created.

Example:

1734455015

time_saved
integer

Unix timestamp when the advertiser was last updated.

Example:

1734455015

relationship
object

Related data (only present when requested via query parameter).