Everflow – Metadata API

Docs: Browser Languages

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/browserlanguages

This list is not an exhaustive list of all languages that could be encountered.

Rather, the languages listed by this endpoint are the ones that can be used (either included or excluded) in your targeting.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/browserlanguages' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "browser_languages": [
        {
            "browser_language_id": 1,
            "language_code": "af",
            "language": "Afrikaans"
        },
        ...,
        {
            "browser_language_id": 20,
            "language_code": "he",
            "language": "Hebrew"
        }
    ]
}

Docs: Browsers

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/browsers

Offers are available to all browsers and this list is not an exhaustive list of all browsers that exist on the market.

Rather, the browsers listed by this endpoint are the ones that can be used (either included or excluded) in your targeting.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/browsers' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "browsers": [
        {
            "browser_id": 1,
            "name": "Mozilla Firefox"
        },
        ...,
        {
            "browser_id": 7,
            "name": "Other"
        }
    ]
}

Docs: Cities

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/cities

Cities are used to narrow down the targeting of your offers, smartlinks, custom settings, etc.

Cities always include both the country information (country_id and country_code) as well as the region information (region_id and region_code) so you can map them directly.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/cities' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "cities": [
        {
            "city_id": 4,
            "city_name": "Abbotsford",
            "region_id": 1080,
            "region_code": "BC",
            "country_id": 36,
            "country_code": "CA"
        },
        ...,
        {
            "city_id": 1354,
            "city_name": "Pittsboro",
            "region_id": 1522,
            "region_code": "NC",
            "country_id": 227,
            "country_code": "US"
        }
    ]
}

Docs: Connection Types

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/connectiontypes

Connection types are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

They are limited to wifi and mobile.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/connectiontypes' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "connection_types": [
        {
            "connection_type_id": 1,
            "name": "wifi"
        },
        {
            "connection_type_id": 2,
            "name": "mobile"
        }
    ]
}

Docs: Countries

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/countries

Countries are useful to narrow down the targeting of your offers, smartlinks, custom settings, etc.

Targeting is done using the country_id, whereas reporting generally maps the country_code in the data.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/countries' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "countries": [
        {
            "country_id": 1,
            "country_code": "AD",
            "country_name": "Andorra"
        },
        ...,
        {
            "country_id": 246,
            "country_code": "CW",
            "country_name": "Curacao"
        }
    ]
}

Docs: Currencies

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/currencies

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/currencies' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "currencies": [
        {
            "currency_id": "AFN",
            "symbol": "؋",
            "name": "Afghan Afghani"
        },
        ...,
        {
            "currency_id": "ZAR",
            "symbol": "R",
            "name": "South African Rand"
        }
    ]
}

The full list of currencies is below. The currency_id column contains the value that typically needs to be used on API endpoints.

currency_id	Symbol	Name
AFN	؋	Afghan Afghani
ALL	Lek	Albanian Lek
ANG	ƒ	Netherlands Antillean Guilder
ARS	$	Argentine Peso
AUD	$	Australian Dollar
AWG	ƒ	Aruban Florin
AZN	ман	Azerbaijani Manat
BAM	KM	Bosnia-Herzegovina Convertible Mark
BBD	$	Barbadian Dollar
BGN	лв	Bulgarian Lev
BMD	$	Bermudan Dollar
BND	$	Brunei Dollar
BOB	b	Bolivian Boliviano
BRL	R$	Brazilian Real
BSD	$	Bahamian Dollar
BWP	P	Botswanan Pula
BYN	p.	Belarusian Ruble
BZD	BZ$	Belize Dollar
CAD	$	Canadian Dollar
CHF	CHF	Swiss Franc
CLP	$	Chilean Peso
CNY	¥	Chinese Yuan
COP	$	Colombian Peso
CRC	₡	Costa Rican Colon
CUP	₱	Cuban Peso
CZK	Kč	Czech Republic Koruna
DKK	kr	Danish Krone
DOP	RD$	Dominican Peso
EGP	£	Egyptian Pound
EUR	€	Euro
FJD	$	Fijian Dollar
FKP	£	Falkland Islands Pound
GBP	£	British Pound Sterling
GIP	£	Gibraltar Pound
GTQ	Q	Guatemalan Quetzal
GYD	$	Guyanaese Dollar
HKD	$	Hong Kong Dollar
HNL	L	Honduran Lempira
HRK	kn	Croatian Kuna
HUF	Ft	Hungarian Forint
IDR	Rp	Indonesian Rupiah
ILS	₪	Israeli New Sheqel
INR	Rp	Indian Rupee
IRR	﷼	Iranian Rial
ISK	kr	Icelandic Krona
JMD	J$	Jamaican Dollar
JPY	¥	Japanese Yen
KGS	лв	Kyrgystani Som
KHR	៛	Cambodian Riel
KPW	₩	North Korean Won
KRW	₩	South Korean Won
KYD	$	Cayman Islands Dollar
KZT	лв	Kazakhstani Tenge
LAK	₭	Laotian Kip
LBP	£	Lebanese Pound
LKR	₨	Sri Lankan Rupee
LRD	$	Liberian Dollar
MKD	ден	Macedonian Denar
MNT	₮	Mongolian Tugrik
MUR	₨	Mauritian Rupee
MXN	$	Mexican Peso
MYR	RM	Malaysian Ringgit
MZN	MT	Mozambican Metical
NAD	$	Namibian Dollar
NGN	₦	Nigerian Naira
NIO	C$	Nicaraguan Cordoba
NOK	kr	Norwegian Krone
NPR	₨	Nepalese Rupee
NZD	$	New Zealand Dollar
OMR	﷼	Omani Rial
PAB	B/.	Panamanian Balboa
PEN	S/.	Peruvian Nuevo Sol
PHP	Php	Philippine Peso
PKR	₨	Pakistani Rupee
PLN	zł	Polish Zloty
PYG	Gs	Paraguayan Guarani
QAR	﷼	Qatari Rial
RON	lei	Romanian Leu
RSD	Дин.	Serbian Dinar
RUB	руб	Russian Ruble
SAR	﷼	Saudi Riyal
SBD	$	Solomon Islands Dollar
SCR	₨	Seychellois Rupee
SEK	kr	Swedish Krona
SGD	$	Singapore Dollar
SHP	£	St. Helena Pound
SOS	S	Somali Shilling
SRD	$	Surinamese Dollar
SVC	$	Salvadoran Colón
SYP	£	Syrian Pound
THB	฿	Thai Baht
TRY	TL	Turkish Lira
TTD	TT$	Trinidad & Tobago Dollar
TWD	NT$	New Taiwan Dollar
UAH	₴	Ukrainian Hryvnia
USD	$	US Dollar
UYU	U	Uruguayan Peso
UZS	лв	Uzbekistan Som
VEF	Bs	Venezuelan Bolívar
VND	₫	Vietnamese Dong
XCD	$	East Caribbean Dollar
YER	﷼	Yemeni Rial
ZAR	R	South African Rand

Docs: Device Brands

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/brands

Offers are available to all brands and this list is not an exhaustive list of all brands that exist on the market.

Rather, the brands listed by this endpoint are the ones that can be used (either included or excluded) in your targeting.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/brands' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "brands": [
        {
            "brand_id": 1,
            "name": "Apple"
        },
        ...,
        {
            "brand_id": 49,
            "name": "Walton"
        }
    ]
}

Docs: Device Types

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/devicetypes

Device types are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/devicetypes' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "device_types": [
        {
            "device_type_id": 1,
            "name": "PC"
        },
        ...,
        {
            "device_type_id": 6,
            "name": "TV"
        }
    ]
}

Docs: DMAs

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/dmas

DMAs, or Designated Market Areas are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

They are available in the US only and are referred to by dma_code.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/dmas' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "dm_as": [
        {
            "dma_code": 500,
            "dma_name": "Portland-Auburn, ME"
        },
        ...,
        {
            "dma_code": 881,
            "dma_name": "Spokane, WA"
        }
    ]
}

Docs: Mobile Carriers

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/mobilecarriers

This is by no means an exhaustive list of all mobile carriers in the world. Rather, this is a list of the mobile carriers you can use to target your offers more specifically.

Mobile carriers are identified by carrier_code and each carrier is specific to a single country (specified by country_id).

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/mobilecarriers' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "mobile_carriers": [
        {
            "mobile_carrier_id": 1,
            "carrier_name": "Bell Mobility Canada",
            "carrier_code": 100,
            "country_id": 36
        },
        ...,
        {
            "mobile_carrier_id": 294,
            "carrier_name": "YooMee Ivory Coast",
            "carrier_code": 7507,
            "country_id": 42
        }
    ]
}

Docs: OS Versions

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/osversions

OS Versions are used to narrow down the targeting of your offers, smartlinks, custom settings, etc.

They are limited to the Android and iOS platforms.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/osversions' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "os_versions": [
        {
            "os_version_id": 1,
            "name": "4.1",
            "platform_id": 1,
            "platform_name": "Android"
        },
        ...,
        {
            "os_version_id": 45,
            "name": "11.0",
            "platform_id": 1,
            "platform_name": "Android"
        }
    ]
}

Docs: Platforms

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/platforms

Offers are available to all platforms and this list is not an exhaustive list of all platforms that exist on the market.

Rather, the platforms listed by this endpoint are the ones that can be used (either included or excluded) in your targeting.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/platforms' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "platforms": [
        {
            "platform_id": 1,
            "name": "Android"
        },
        ...,
        {
            "platform_id": 22,
            "name": "Nintendo OS"
        }
    ]
}

Docs: Regions

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/regions

Regions are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

They always include the country information (country_id and country_code) so you can map them directly.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/regions' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "regions": [
        {
            "region_id": 2,
            "region_code": "01",
            "country_id": 6,
            "country_code": "AL",
            "region_name": "Region 1"
        },
        ...,
        {
            "region_id": 4709,
            "region_code": "AP",
            "country_id": 227,
            "country_code": "US",
            "region_name": "Region 2"
        }
    ]
}

Docs: Timezones

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/meta/timezones

Timezones are used in most API endpoints where dates and time are involved (reporting endpoints, for example).

The timezone UTC with an offset of 00:00 has the timezone_id: 67.

You can find the timezone your account is using by accessing the base endpoint for your network. The response will contain your timezone_id.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/meta/timezones' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "timezones": [
        {
            "timezone_id": 1,
            "timezone_name": "Line Is. Time (Pacific/Kiritimati)",
            "timezone": "Pacific/Kiritimati",
            "utc_offset": "+14:00"
        },
        ...,
        {
            "timezone_id": 99,
            "timezone_name": "Samoa Standard Time (Pacific/Pago_Pago)",
            "timezone": "Pacific/Pago_Pago",
            "utc_offset": "-11:00"
        }
    ]
}

The full list of timezones is below. The timezone_id column contains the value that typically needs to be used on API endpoints.

timezone_id	Name	UTC Offset
1	Pacific/Kiritimati	+14:00
2	Pacific/Enderbury	+13:00
3	Pacific/Tongatapu	+13:00
4	Pacific/Chatham	+13:45
5	Pacific/Auckland	+13:00
6	Pacific/Fiji	+13:00
7	Asia/Kamchatka	+12:00
8	Pacific/Norfolk	+12:00
9	Australia/Lord_Howe	+11:00
10	Pacific/Guadalcanal	+11:00
11	Australia/Adelaide	+10:30
12	Australia/Sydney	+11:00
13	Australia/Brisbane	+10:00
14	Australia/Darwin	+09:30
15	Asia/Seoul	+09:00
16	Asia/Tokyo	+09:00
17	Asia/Hong_Kong	+08:00
18	Asia/Kuala_Lumpur	+08:00
19	Asia/Manila	+08:00
20	Asia/Shanghai	+08:00
21	Asia/Singapore	+08:00
22	Asia/Taipei	+08:00
23	Australia/Perth	+08:00
24	Asia/Bangkok	+07:00
25	Asia/Ho_Chi_Minh	+07:00
26	Asia/Jakarta	+07:00
27	Asia/Rangoon	+06:30
28	Asia/Dhaka	+06:00
29	Asia/Kathmandu	+05:45
30	Asia/Colombo	+05:30
31	Asia/Kolkata	+05:30
32	Asia/Karachi	+05:00
33	Asia/Tashkent	+05:00
34	Asia/Yekaterinburg	+05:00
35	Asia/Kabul	+04:30
36	Asia/Baku	+04:00
37	Asia/Dubai	+04:00
38	Asia/Tbilisi	+04:00
39	Asia/Yerevan	+04:00
40	Asia/Tehran	+03:30
41	Africa/Nairobi	+03:00
42	Asia/Baghdad	+03:00
43	Asia/Kuwait	+03:00
44	Asia/Riyadh	+03:00
45	Europe/Minsk	+03:00
46	Europe/Moscow	+03:00
47	Africa/Cairo	+02:00
48	Asia/Beirut	+02:00
49	Asia/Jerusalem	+02:00
50	Europe/Athens	+02:00
51	Europe/Bucharest	+02:00
52	Europe/Helsinki	+02:00
53	Europe/Istanbul	+03:00
54	Africa/Johannesburg	+02:00
55	Europe/Amsterdam	+01:00
56	Europe/Berlin	+01:00
57	Europe/Brussels	+01:00
58	Europe/Paris	+01:00
59	Europe/Prague	+01:00
60	Europe/Rome	+01:00
61	Europe/Lisbon	+00:00
62	Africa/Algiers	+01:00
63	Europe/London	+00:00
64	Atlantic/Cape_Verde	-01:00
65	Africa/Casablanca	+01:00
66	Europe/Dublin	+00:00
67	UTC	+00:00
68	America/Scoresbysund	-01:00
69	Atlantic/Azores	-01:00
70	Atlantic/South_Georgia	-02:00
71	America/St_Johns	-03:30
72	America/Sao_Paulo	-03:00
73	America/Argentina/Buenos_Aires	-03:00
74	America/Santiago	-03:00
75	America/Halifax	-04:00
76	America/Puerto_Rico	-04:00
77	Atlantic/Bermuda	-04:00
78	America/Caracas	-04:00
79	America/Indiana/Indianapolis	-05:00
80	America/New_York	-05:00
81	America/Bogota	-05:00
82	America/Lima	-05:00
83	America/Panama	-05:00
84	America/Mexico_City	-06:00
85	America/Chicago	-06:00
86	America/El_Salvador	-06:00
87	America/Denver	-07:00
88	America/Mazatlan	-07:00
89	America/Phoenix	-07:00
90	America/Los_Angeles	-08:00
91	America/Tijuana	-08:00
92	Pacific/Pitcairn	-08:00
93	America/Anchorage	-09:00
94	Pacific/Gambier	-09:00
95	America/Adak	-10:00
96	Pacific/Marquesas	-09:30
97	Pacific/Honolulu	-10:00
98	Pacific/Niue	-11:00
99	Pacific/Pago_Pago	-11:00