Marketplace Advertisers

Operations to fetch information about marketplace advertisers

The Marketplace Advertiser Object

The Marketplace Advertiser object returned by the API endpoints documented here can be defined as such :

everxchange_demand_partner_id int

The Marketplace Advertiser’s unique ID

network_id int

The Everflow Network or “client” ID for this advertiser. This ID would be same as the one used on all the other Everflow APIs (network, affiliate, etc.)

company_name string

The Everflow Network or “client” ID for this advertiser. This ID would be same as the one used on all the other Everflow APIs (network, affiliate, etc.)

status string

The Marketplace Advertiser’s account status. Can be either active or deleted

logo_url string

Marketplace Advertiser’s logo. This asset will always be hosted on an Everflow’s domain

logo_asset_id int

Unique ID of the logo’s asset

website_url string

The Marketplace Advertiser’s website

public_description string

A description of the company, written by the Marketplace Advertiser themselves

facebook_contact_url string

An optional link to the Marketplace Advertiser’s Facebook presence

instagram_contact_url string

An optional link to the Marketplace Advertiser’s Instagram presence

twitter_contact_url string

An optional link to the Marketplace Advertiser’s Twitter presence

tiktok_contact_url string

An optional link to the Marketplace Advertiser’s TikTok presence

linkedin_contact_url string

An optional link to the Marketplace Advertiser’s LinkedIn presence

youtube_contact_url string

An optional link to the Marketplace Advertiser’s Youtube presence

is_contact_info_public boolean

Determines whether the Marketplace Advertiser chose to make their contact information available publicly

link string

An option for the Marketplace Advertiser to provide a link relevant to their program (e.g. Telegram Group invite, Relevant information stored elsewhere, etc.)

custom_link_label string

Only relevant if the link field documented above is filled. Describes what the link is about.

default_network_offer_id int

Certain Publishers (Marketplace Partners) require Marketplace Advertisers they connect with to provide an always-accessible, public, Default Marketplace Offer. This field will return the offer ID of the Default Marketplace Offer if it has been set by the Advertiser, otherwise it will return 0.


Get All Marketplace Advertisers

POST /v1/partners/marketplace/demands

This endpoint return a list of Marketplace Advertisers. The response will not contain the Marketplace Advertisers you are already connected with.

Though this endpoint is a POST it does not currently support filters. You can therefore use it by passing an empty JSON body.

cURL
curl --request POST \
  --url https://api.eflow.team/v1/partners/marketplace/demands \
  --header 'Content-Type: application/json' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --data '{
}'

Example 1 : Fetch all Marketplace Advertisers

Response
{
	"demand_partners": [
		{
			"everxchange_demand_partner_id": 19,
			"network_id": 7234,
			"company_name": "Example.com",
			"status": "active",
			"logo_url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
			"logo_asset_id": 147,
			"website_url": "http://example.com",
			"public_description": "A placeholder brand that's used for API documentation",
			"facebook_contact_url": "",
			"instagram_contact_url": "",
			"twitter_contact_url": "",
			"is_contact_info_public": true,
			"tiktok_contact_url": "",
			"youtube_contact_url": "",
			"linkedin_contact_url": "",
			"custom_link_label": "",
			"link": "",
			"default_network_offer_id": 0,
			"time_created": 1574814836,
			"time_saved": 1717529716,
			"relationship": {
				"vertical_ids": [
					9,
					10,
					16,
					17
				],
				"channel_ids": [
					3,
					6,
					10,
					14,
					16,
					20,
					22,
					26,
					27,
					28
				],
				"geo_vertical_ids": [
					1001
				],
				"contact": {
					"fist_name": "John",
					"last_name": "Doe",
					"phone_number": "",
					"email": "john.doe@example.com"
				},
				"affinity_match_count": 2,
				"resource_asset": {
					"customer_asset_id": 147,
					"content_type": "image/png",
					"filename": "example.png",
					"url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
					"file_size": 13635,
					"time_saved": 1652712073
				},
				"programs": [
					{
						"everxchange_demand_partner_program_id": 247,
						"everxchange_demand_partner_id": 19,
						"name": "Example",
						"preview_url": "https://example.com/",
						"ordering_value": 1,
						"time_created": 1717529716,
						"time_saved": 1717529716
					}
				],
				"performance": {
					"everxchange_demand_partner_id": 19,
					"clicks_weekly": 123042,
					"has_reached_weekly_threshold": false,
					"epc_weekly": 0.1906,
					"cvr_weekly": 0.0576,
					"clicks_monthly": 834925,
					"has_reached_monthly_threshold": false,
					"epc_monthly": 0.2147,
					"cvr_monthly": 0.0643,
					"time_created": 1695804176,
					"time_saved": 1730450196
				},
				"payout_type_ids": [
					4
				],
				"network_currency_id": "USD"
			}
		}
	]
}

Get Marketplace Advertiser By ID

GET /v1/partners/marketplace/demands/:marketplaceAdvertiserId

This endpoint returns the details of a specific Marketplace Advertiser ID.

cURL
curl --request GET \
  --url 'https://api.eflow.team/v1/partners/marketplace/demands/<everxchange_demand_partner_id>' \
  --header 'Content-Type: application/json' \
  --header 'x-eflow-api-key: <INSERT API KEY>'

Example 1 : Fetch a Marketplace Advertiser

Response
{
	"demand_partners": [
		{
			"everxchange_demand_partner_id": 19,
			"network_id": 7234,
			"company_name": "Example.com",
			"status": "active",
			"logo_url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
			"logo_asset_id": 147,
			"website_url": "http://example.com",
			"public_description": "A placeholder brand that's used for API documentation",
			"facebook_contact_url": "",
			"instagram_contact_url": "",
			"twitter_contact_url": "",
			"is_contact_info_public": true,
			"tiktok_contact_url": "",
			"youtube_contact_url": "",
			"linkedin_contact_url": "",
			"custom_link_label": "",
			"link": "",
			"default_network_offer_id": 0,
			"time_created": 1574814836,
			"time_saved": 1717529716,
			"relationship": {
				"vertical_ids": [
					9,
					10,
					16,
					17
				],
				"channel_ids": [
					3,
					6,
					10,
					14,
					16,
					20,
					22,
					26,
					27,
					28
				],
				"geo_vertical_ids": [
					1001
				],
				"contact": {
					"fist_name": "John",
					"last_name": "Doe",
					"phone_number": "",
					"email": "john.doe@example.com"
				},
				"affinity_match_count": 2,
				"resource_asset": {
					"customer_asset_id": 147,
					"content_type": "image/png",
					"filename": "example.png",
					"url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
					"file_size": 13635,
					"time_saved": 1652712073
				},
				"programs": [
					{
						"everxchange_demand_partner_program_id": 247,
						"everxchange_demand_partner_id": 19,
						"name": "Example",
						"preview_url": "https://example.com/",
						"ordering_value": 1,
						"time_created": 1717529716,
						"time_saved": 1717529716
					}
				],
				"performance": {
					"everxchange_demand_partner_id": 19,
					"clicks_weekly": 123042,
					"has_reached_weekly_threshold": false,
					"epc_weekly": 0.1906,
					"cvr_weekly": 0.0576,
					"clicks_monthly": 834925,
					"has_reached_monthly_threshold": false,
					"epc_monthly": 0.2147,
					"cvr_monthly": 0.0643,
					"time_created": 1695804176,
					"time_saved": 1730450196
				},
				"payout_type_ids": [
					4
				],
				"network_currency_id": "USD"
			}
		}
	]
}