--- title: "Get Advertiser by ID" method: GET path: "/networks/advertisers/{advertiserId}" tags: ["Advertisers"] --- # Get Advertiser by ID `GET /networks/advertisers/{advertiserId}` ## Request - Base URL: `https://api.eflow.team/v1` - URL: `https://api.eflow.team/v1/networks/advertisers/{advertiserId}` - Auth: API key in header `X-Eflow-Api-Key` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `advertiserId` integer, required ## Query parameters - `relationship` 'reporting' | 'labels' | 'demand_partner' | 'billing' | 'integrations' | 'api' | 'settings' | 'product_feed' | 'deal' ## Response `200` - Advertiser - `network_advertiser_id` integer: Unique advertiser ID. - `network_id` integer: Network ID. - `name` string: Advertiser name. - `account_status` 'active' | 'inactive' | 'pending' | 'suspended': Current account status. - `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` '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_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, nullable: Whether publisher reporting data is exposed to this advertiser. - `contact_address` object: Contact address. Only used in create/update requests. - `address_1` string - `address_2` string - `city` string - `region_code` string - `country_code` string - `zip_postal_code` string - `labels` string[]: Labels to assign. Only used in create/update requests. Use the relationship object to read labels. - `time_created` integer: Unix timestamp when the advertiser was created. - `time_saved` integer: Unix timestamp when the advertiser was last updated. - `relationship` object: Related data (only present when requested via query parameter). - `labels` object: Labels assigned to this advertiser. - `total` integer: Total number of labels. - `entries` string[]: List of label strings. - `users` object: User accounts associated with this advertiser. - `total` integer - `entries` object[] - `network_advertiser_user_id` integer: Unique user ID. - `network_id` integer: Network ID. - `network_advertiser_id` integer: Advertiser ID this user belongs to. - `first_name` string: User's first name. - `last_name` string: User's last name. - `email` string: User's email address. - `title` string: User's title. - `account_status` 'active' | 'inactive': User's account status. - `work_phone` string: Work phone number. - `cell_phone` string: Cell phone number. - `instant_messaging_id` integer: Instant messaging platform ID. - `instant_messaging_identifier` string: Instant messaging handle. - `language_id` integer: Language ID. - `timezone_id` integer: Timezone ID. - `currency_id` string: ISO currency code. - `time_created` integer: Unix timestamp of creation. - `time_saved` integer: Unix timestamp of last update. - `account_manager` object - `first_name` string - `last_name` string - `email` string - `work_phone` string - `cell_phone` string - `instant_messaging_id` integer: The ID of an instant messaging platform. Allows you to save the user's identifier for further reference. - `instant_messaging_identifier` string: Username or handle for the messaging platform. - `sale_manager` object - `first_name` string - `last_name` string - `email` string - `work_phone` string - `cell_phone` string - `instant_messaging_id` integer: The ID of an instant messaging platform. Allows you to save the user's identifier for further reference. - `instant_messaging_identifier` string: Username or handle for the messaging platform. - `reporting` object: Reporting metrics for this advertiser (only present when requested via `?relationship=reporting`). - `gross_click` integer: Total gross clicks (including invalid). - `total_click` integer: Total valid clicks. - `unique_click` integer: Unique clicks. - `duplicate_click` integer: Duplicate clicks. - `invalid_click` integer: Invalid or flagged clicks. - `cv` integer: Conversions. - `total_cv` integer: Total conversions (including view-through). - `view_through_cv` integer: View-through conversions. - `event` integer: Total events. - `imp` integer: Impressions. - `revenue` number, double: Total revenue. - `payout` number, double: Total payout. - `event_revenue` number, double: Revenue from events. - `profit` number, double: Total profit (revenue minus payout). - `margin` number, double: Profit margin percentage. - `media_buying_cost` number, double: Media buying cost. - `gross_sales` number, double: Gross sales amount. - `avg_sale_value` number, double: Average sale value. - `cpc` number, double: Cost per click. - `cpa` number, double: Cost per action. - `cpm` number, double: Cost per mille (thousand impressions). - `epc` number, double: Earnings per click. - `rpc` number, double: Revenue per click. - `rpa` number, double: Revenue per action. - `rpm` number, double: Revenue per mille. - `ctr` number, double: Click-through rate. - `cvr` number, double: Conversion rate. - `evr` number, double: Event rate. - `roas` number, double: Return on ad spend. - `invalid_cv_scrub` integer: Scrubbed invalid conversions. - `on_hold_potential_revenue` number, double: Revenue from on-hold conversions. - `on_hold_potential_payout` number, double: Payout from on-hold conversions. - `on_hold_conversion_count` integer: Number of on-hold conversions. - `public_events` integer: Number of public events. - `billing` object: Billing configuration (only present when requested via `?relationship=billing`). - `network_id` integer: Network ID. - `network_advertiser_id` integer: Advertiser ID. - `billing_frequency` 'weekly' | 'bimonthly' | 'monthly' | 'two_months' | 'quarterly' | 'manual' | 'other': How often the advertiser is invoiced. - `invoice_amount_threshold` number, double: Minimum amount to trigger invoice generation. - `tax_id` string: Tax ID / VAT or SSN. - `is_invoice_creation_auto` boolean: Whether invoices are generated automatically. - `auto_invoice_start_date` string: Start date for automatic invoicing. - `default_invoice_is_hidden` boolean: Whether invoices are hidden from the advertiser. - `invoice_generation_days_delay` integer: Days to wait after billing period before generating invoice. - `default_payment_terms` integer: Payment terms in days. - `relationship` object: Billing schedule details, keyed by frequency type (e.g. `monthly`, `weekly`). - `integrations` object: Integration settings (only present when requested via `?relationship=integrations`). - `advertiser_demand_partner` object: Demand partner integration configuration. - `demand_partner` object: Demand partner settings. - `contact_address` object: Contact address on file for this advertiser. - `address_id` integer: Address record ID. - `network_id` integer: Network ID. - `address_1` string: Street address line 1. - `address_2` string: Street address line 2. - `city` string: City name. - `region_code` string: State or region code (e.g. "CA"). - `country_id` integer: Numeric country ID. - `country_code` string: Two-letter country code (e.g. "US"). - `zip_postal_code` string: ZIP or postal code. - `api_keys` object: API keys associated with this advertiser. - `total` integer: Total number of API keys. - `entries` object[] - `network_api_key_id` integer: Unique API key record ID. - `network_id` integer: Network ID. - `resource_id` integer: Resource ID this key is associated with. - `api_key` string: The API key string. - `resource_type` string: Type of resource (e.g. "advertiser"). - `key_status` 'active' | 'revoked': Current status of the API key. - `network_employee_id` integer: Employee who created the key. - `time_created` integer: Unix timestamp of creation. - `time_saved` integer: Unix timestamp of last update. - `modules` object, nullable: API modules this key has access to. - `api_key_name` string: Display name for the API key. - `relationship_modules` object, nullable: Related module permissions. - `relationship_resource` object, nullable: Related resource details. - `last_usage` integer: Unix timestamp of last usage. - `api_key_hash` string: Hash of the API key. - `api_whitelist_ips` object: Whitelisted IP addresses for API access. - `total` integer - `entries` object[] - `settings` object: Advertiser-specific settings (only present when requested via `?relationship=settings`). - `network_id` integer: Network ID. - `network_advertiser_id` integer: Advertiser ID. - `exposed_variables` object: Controls which tracking variables are visible to this advertiser in reporting. - `affiliate_id` boolean: Whether the affiliate ID is exposed. - `affiliate` boolean: Whether the affiliate name is exposed. - `sub1` boolean: Whether sub-parameter 1 is exposed. - `sub2` boolean: Whether sub-parameter 2 is exposed. - `sub3` boolean: Whether sub-parameter 3 is exposed. - `sub4` boolean: Whether sub-parameter 4 is exposed. - `sub5` boolean: Whether sub-parameter 5 is exposed. - `sub6` boolean: Whether sub-parameter 6 is exposed. - `sub7` boolean: Whether sub-parameter 7 is exposed. - `sub8` boolean: Whether sub-parameter 8 is exposed. - `sub9` boolean: Whether sub-parameter 9 is exposed. - `sub10` boolean: Whether sub-parameter 10 is exposed. - `source_id` boolean: Whether the source ID is exposed. - `offer_url` boolean: Whether the offer URL is exposed. - `time_saved` integer: Unix timestamp of last update. - `product_feeds` object[]: Product feeds configured for this advertiser (only present when requested via `?relationship=product_feed`). - `network_advertiser_product_feed_id` integer: Unique product feed ID. - `network_id` integer: Network ID. - `network_advertiser_id` integer: Advertiser ID. - `name` string: Product feed name. - `status` string: Feed status (e.g. "active"). - `apply_to_all_affiliates` boolean: Whether this feed applies to all affiliates. - `affiliate_ids` integer[]: Specific affiliate IDs this feed applies to. - `offer_ids` integer[]: Offer IDs associated with this feed. - `file_asset_id` integer: Uploaded file asset ID. - `date_valid_from` integer: Unix timestamp of validity start. - `date_valid_to` integer: Unix timestamp of validity end. - `date_valid_timezone_id` integer: Timezone ID for validity dates. - `document_file` string: Document file URL or path. - `time_saved` integer: Unix timestamp of last update. - `time_created` integer: Unix timestamp of creation. - `deals` object[]: Deals configured for this advertiser (only present when requested via `?relationship=deal`). - `network_advertiser_deal_id` integer: Unique deal ID. - `network_id` integer: Network ID. - `network_advertiser_id` integer: Advertiser ID. - `name` string: Deal name. - `deal_type` string: Type of deal. - `deal_status` string: Current deal status. - `deal_categories` string[]: Categories associated with this deal. - `description` string: Deal description. - `restrictions` string: Deal restrictions or terms. - `scope` string: Deal scope. - `coupon_code` string: Coupon code for this deal. - `coupon_code_discount_percentage` number: Discount percentage applied by the coupon. - `coupon_code_discount_amount` number: Fixed discount amount applied by the coupon. - `coupon_code_discount_currency_id` string: Currency for the discount amount. - `threshold_quantity` integer: Minimum quantity threshold to trigger the deal. - `threshold_amount` number: Minimum spend threshold to trigger the deal. - `threshold_amount_currency_id` string: Currency for the threshold amount. - `purchase_limit_quantity` integer: Maximum purchase quantity. - `purchase_limit_amount` number: Maximum purchase amount. - `purchase_limit_amount_currency_id` string: Currency for the purchase limit. - `apply_to_all_affiliates` boolean: Whether this deal applies to all affiliates. - `affiliate_ids` integer[]: Specific affiliate IDs this deal applies to. - `offer_ids` integer[]: Offer IDs associated with this deal. - `date_valid_from` integer: Unix timestamp of validity start. - `date_valid_to` integer: Unix timestamp of validity end. - `date_valid_timezone_id` integer: Timezone ID for validity dates. - `brand_name` string: Brand name associated with this deal. - `time_saved` integer: Unix timestamp of last update. - `time_created` integer: Unix timestamp of creation. - `time_deleted` integer: Unix timestamp of deletion (0 if not deleted). ## Other responses - `404`: Advertiser not found. --- [API](https://skmtc.dev/everflow/apis/everflow-network-api-tracking-domains.md) - [All operations](https://skmtc.dev/everflow/apis/everflow-network-api-tracking-domains/llms.txt) - [OpenAPI document](https://skmtc.dev/everflow/apis/everflow-network-api-tracking-domains/revisions/39242cee0e32?raw)