{ "info": { "_postman_id": "14cab875-c310-4928-803f-a4763064ceba", "name": "Eskimi API template", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "45395431", "_collection_link": "https://go.postman.co/collection/45395431-14cab875-c310-4928-803f-a4763064ceba?source=collection_link" }, "item": [ { "name": "Authentication", "item": [ { "name": "Authorization", "event": [ { "listen": "test", "script": { "exec": [ "let json = pm.response.json();", "pm.environment.set(\"ACCESS_TOKEN\", json.access_token);" ], "type": "text/javascript", "packages": {}, "requests": {} } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"client_id\": id, // Integer: Generated ClientID from Eskimi DSP\n \"client_secret\": \"client secret\", // String: Generated ClientSecret from Eskimi DSP\n \"grant_type\": \"eskimi_dsp\", // String: Must be 'eskimi_dsp'\n \"username\": \"username/email\", // String: Eskimi DSP username/email\n \"password\": \"password\" // String: Eskimi DSP password\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}oauth/token", "host": [ "{{base_url}}oauth" ], "path": [ "token" ] } }, "response": [] } ], "description": "The {{ACCESS_TOKEN}} is stored dynamically, you will not need to copy it by hand.", "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "AdPlacementPositions", "item": [ { "name": "GetAdPlacementPositions", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/adPlacementPositions/get", "host": [ "{{base_url}}v1" ], "path": [ "adPlacementPositions", "get" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "AdPlacementTypes", "item": [ { "name": "GetAdPlacementTypes", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/adPlacementTypes/get", "host": [ "{{base_url}}v1" ], "path": [ "adPlacementTypes", "get" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "AgeGroups", "item": [ { "name": "GetAgeGroups", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/ageGroups/get", "host": [ "{{base_url}}v1" ], "path": [ "ageGroups", "get" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Audience", "item": [ { "name": "CreatesAudienceByDmpIDs", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": ADVERTISER_ID, // Integer: The user (advertiser) ID\n \"name\": \"name\", // String: Name of the audience\n \"dmpIds\": [\"id\"], // Array: List of DMP IDs\n \"userValidityMinutes\": 1000, // Integer: User expiration time (in minutes)\n \"hashedList\": 0, // Integer (optional): 1 if DMP IDs are SHA256-hashed; otherwise 0\n \"description\": \"description\" // String (optional): Description of the audience\n}\n" }, "url": { "raw": "{{base_url}}v1/audience/dmp/create", "host": [ "{{base_url}}v1" ], "path": [ "audience", "dmp", "create" ] } }, "response": [] }, { "name": "CreatesBehaviouralAudience", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": ADVERTISER_ID, // Integer: The user (advertiser) ID\n \"name\": \"NAME\", // String: Name of the audience\n \"interestIds\": [ARRAY_OF_INTEREST_IDS], // Array: List of interest IDs\n \"description\": \"OPTIONAL_DESCRIPTION\", // String (optional): Description of the audience\n \"country\": \"OPTIONAL_COUNTRY_CODE\" // String (optional): ISO 3166-2 alpha-2 two-letter country code\n}\n" }, "url": { "raw": "{{base_url}}v1/audience/behavioural/create", "host": [ "{{base_url}}v1" ], "path": [ "audience", "behavioural", "create" ] } }, "response": [] }, { "name": "DeleteBehavioralAudience", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/audience/behavioural/delete/{{AUDIENCE_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "audience", "behavioural", "delete", "{{AUDIENCE_ID}}" ] } }, "response": [] }, { "name": "DeleteDmpAudience", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/audience/dmp/delete/{{AUDIENCE_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "audience", "dmp", "delete", "{{AUDIENCE_ID}}" ] } }, "response": [] }, { "name": "GetAudienceInterests", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base_url}}v1/audience/interests/get", "host": [ "{{base_url}}v1" ], "path": [ "audience", "interests", "get" ] } }, "response": [] }, { "name": "GetDmpIDsForAudience", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base_url}}v1/audience/dmpIds/get/{{AUDIENCE_ID}}?cursor=&advertiserId=", "host": [ "{{base_url}}v1" ], "path": [ "audience", "dmpIds", "get", "{{AUDIENCE_ID}}" ], "query": [ { "key": "cursor", "value": "", "description": "Pagination value return from the server at first call, have to use to from second call" }, { "key": "advertiserId", "value": "", "description": "The advertiser ID" } ] } }, "response": [] }, { "name": "UpdateBehavioralAudience", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": id, // Integer: The advertiser ID\n \"name\": \"name\", // String: Name of the audience\n \"interestIds\": [\"id\"], // Array: List of interest IDs\n \"description\": \"Description\" // String: Description of the audience\n}\n" }, "url": { "raw": "{{base_url}}v1/audience/behavioural/update/{{AUDIENCE_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "audience", "behavioural", "update", "{{AUDIENCE_ID}}" ] } }, "response": [] }, { "name": "UpdateDmpAudience", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": id, // Integer: The advertiser/user ID\n \"name\": \"name\", // String: Name of the audience\n \"dmpIds\": [\"dmp ids\"], // Array: List of DMP IDs\n \"userValidityMinutes\": 1000, // Integer: Validity of DMP IDs in minutes\n \"hashedList\": 0, // Integer (optional): 1 if DMP IDs are SHA256 hashed; valid values 0 or 1\n \"description\": \"description\" // String: Description of the audience\n}\n" }, "url": { "raw": "{{base_url}}v1/audience/dmp/update/{{AUDIENCE_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "audience", "dmp", "update", "{{AUDIENCE_ID}}" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Campaign", "item": [ { "name": "CreateCampaignBannerType", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": ADVERTISER_ID, // Integer: The user ID\n \"name\": \"CAMPAIGN_NAME\", // String: Name of the campaign\n \"adDomain\": \"AD_DOMAIN\", // String: Domain/host of the campaign e.g. \"eskimi.com\"\n \"clickUrl\": \"CLICK_URL\", // String: Click URL of the campaign\n \"dates\": { // Object: Campaign targeting dates\n \"from\": \"START_DATE\", // String (date): Start date, must be current or later\n \"to\": \"END_DATE\" // String (date): End date, must be after start date\n },\n \"country\": \"COUNTRY_CODE\", // String: ISO 3166-2 alpha-2 two-letter lowercase targeting country code\n \"bid\": BID_AMOUNT, // Float: Campaign bid size between 0.1 and 10\n \"budget\": { // Object: Budget details\n \"type\": \"BUDGET_TYPE_DAILY_OR_TOTAL\", // String: \"daily\" or \"total\"\n \"amount\": BUDGET_AMOUNT, // Number: Budget amount\n \"pacing\": PACING // Number: Pacing value\n },\n \"creativeSetIds\": [CREATIVE_SET_IDS], // Array: List of creative set IDs\n\n \"hours\": { // (Optional) Object: Map of targeting hours per weekday (1 = Monday, ..., 7 = Sunday)\n \"1\": [HOURS_MON], // (Optional) Array of integers (0–23)\n \"2\": [HOURS_TUE],\n \"3\": [HOURS_WED],\n \"4\": [HOURS_THU],\n \"5\": [HOURS_FRI],\n \"6\": [HOURS_SAT],\n \"7\": [HOURS_SUN]\n },\n\n \"stateIds\": [STATE_IDS], // (Optional) Array: List of country state IDs\n \"operatorIds\": [OPERATOR_IDS], // (Optional) Array: List of mobile operator IDs\n \"exchangeIds\": [EXCHANGE_IDS], // (Optional) Array: List of exchange IDs\n\n \"exchangeSettings\": { // (Optional) Object: Extra settings for exchanges\n \"11\": { // (Optional) Object: Settings specific to Facebook (exchange ID 11)\n \"page_id\": \"FACEBOOK_PAGE_ID\", // (Optional) String: Facebook page ID\n \"object_story_id\": \"OBJECT_STORY_ID\", // (Optional) String: Facebook object story ID\n \"budget_type\": \"Daily\" // (Optional) String: Budget type for Facebook (\"daily\" or \"lifetime\")\n }\n },\n\n \"audienceIds\": [AUDIENCE_IDS], // (Optional) Array: List of audience IDs\n \"adPlacementTypeIds\": [PLACEMENT_TYPE_IDS], // (Optional) Array: List of ad placement type IDs\n \"adPlacementPositionIds\": [PLACEMENT_POSITION_IDS], // (Optional) Array: List of ad placement position IDs\n \"privateMarketplaceIds\": [PRIVATE_MARKETPLACE_IDS], // (Optional) Array: List of private marketplace IDs\n \"wifi\": WIFI_0_OR_1, // (Optional) Integer: Target WiFi devices? 0 or 1\n \"autoStart\": AUTO_START_0_OR_1, // (Optional) Integer: Should campaign start automatically? 0 or 1\n\n \"device\": { // (Optional) Object: Device targeting parameters\n \"typeIds\": [DEVICE_TYPE_IDS],\n \"connectionIds\": [CONNECTION_IDS],\n \"osIds\": [OS_IDS],\n \"browserIds\": [BROWSER_IDS],\n \"brandIds\": [BRAND_IDS],\n \"brandType\": BRAND_TYPE_INCLUDE_OR_EXCLUDE, // Integer: 1 = include, 2 = exclude\n \"modelIds\": [MODEL_IDS],\n \"modelType\": MODEL_TYPE_INCLUDE_OR_EXCLUDE // Integer: 1 = include, 2 = exclude\n },\n\n \"capping\": { // (Optional) Object: Campaign capping parameters\n \"impressions\": CAPPING_IMPRESSIONS,\n \"clicks\": CAPPING_CLICKS,\n \"impressionInterval\": INTERVAL_VALUE,\n \"impressionIntervalType\": \"INTERVAL_TYPE_H_OR_D\", // String: \"h\" (hours) or \"d\" (days)\n \"cappingType\": CAPPING_TYPE_0_OR_1 // Integer: 0 = User, 1 = App/Site\n },\n\n \"optimisation\": { // (Optional) Object: Campaign optimisation parameters\n \"type\": \"OPTIMISATION_TYPE_CPC_CTR_OR_CPA\", // String: \"CPC\", \"CTR\", or \"CPA\"\n \"target\": OPTIMISATION_TARGET,\n \"impressions\": OPTIMISATION_IMPRESSIONS,\n \"spent\": OPTIMISATION_SPENT\n },\n\n \"preOptimisation\": PRE_OPTIMISATION_0_OR_2 // (Optional) Integer: 0 or 2\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}v1/campaign/banner/create", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "banner", "create" ] } }, "response": [] }, { "name": "CreateCampaignNativeType", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": ADVERTISER_ID, // Integer: The user ID\n \"name\": \"CAMPAIGN_NAME\", // String: Name of the campaign\n \"adDomain\": \"AD_DOMAIN\", // String: Domain/host of the campaign (e.g. \"eskimi.com\")\n \"clickUrl\": \"CLICK_URL\", // String: Click URL of the campaign\n\n \"dates\": { // Object: Campaign targeting dates\n \"from\": \"START_DATE\", // String: Start date (YYYY-MM-DD), must be today or later\n \"to\": \"END_DATE\" // String: End date (YYYY-MM-DD), must be after start date\n },\n\n \"country\": \"COUNTRY_CODE\", // String: ISO 3166-2 alpha-2 lowercase country code\n \"bid\": BID_AMOUNT, // Float: Campaign bid size between 0.1 and 10\n\n \"budget\": { // Object: Budget configuration\n \"type\": \"BUDGET_TYPE_DAILY_OR_TOTAL\", // String: \"daily\" or \"total\"\n \"amount\": BUDGET_AMOUNT, // Number: Budget amount\n \"pacing\": PACING // Number: Budget pacing\n },\n\n \"creativeSetIds\": [CREATIVE_SET_IDS], // Array: List of creative set IDs\n\n \"hours\": { // (optional) Object: Hour targeting by day (1 = Monday ... 7 = Sunday)\n \"1\": [HOURS_MON],\n \"2\": [HOURS_TUE],\n \"3\": [HOURS_WED],\n \"4\": [HOURS_THU],\n \"5\": [HOURS_FRI],\n \"6\": [HOURS_SAT],\n \"7\": [HOURS_SUN]\n },\n\n \"stateIds\": [STATE_IDS], // (optional) Array: List of country state IDs\n \"operatorIds\": [OPERATOR_IDS], // (optional) Array: List of mobile operator IDs\n \"exchangeIds\": [EXCHANGE_IDS], // (optional) Array: List of exchange IDs\n \"audienceIds\": [AUDIENCE_IDS], // (optional) Array: List of audience IDs\n \"adPlacementTypeIds\": [PLACEMENT_TYPE_IDS], // (optional) Array: List of ad placement type IDs\n \"adPlacementPositionIds\": [PLACEMENT_POSITION_IDS], // (optional) Array: List of ad placement position IDs\n \"privateMarketplaceIds\": [PRIVATE_MARKETPLACE_IDS], // (optional) Array: List of private marketplace IDs\n\n \"wifi\": WIFI_0_OR_1, // (optional) Integer: Target WiFi devices? 0 = No, 1 = Yes\n \"autoStart\": AUTO_START_0_OR_1, // (optional) Integer: Should campaign auto-start? 0 = No, 1 = Yes\n\n \"device\": { // (optional) Object: Device targeting options\n \"typeIds\": [DEVICE_TYPE_IDS], // Array: Device type IDs\n \"connectionIds\": [CONNECTION_IDS], // Array: Connection type IDs\n \"osIds\": [OS_IDS], // Array: OS IDs\n \"browserIds\": [BROWSER_IDS], // Array: Browser IDs\n \"brandIds\": [BRAND_IDS], // Array: Brand IDs\n \"brandType\": BRAND_TYPE_INCLUDE_OR_EXCLUDE, // Integer: 1 = include, 2 = exclude\n \"modelIds\": [MODEL_IDS], // Array: Device model IDs\n \"modelType\": MODEL_TYPE_INCLUDE_OR_EXCLUDE // Integer: 1 = include, 2 = exclude\n },\n\n \"capping\": { // (optional) Object: Capping settings\n \"impressions\": CAPPING_IMPRESSIONS, // Integer: Max impressions per user\n \"clicks\": CAPPING_CLICKS, // Integer: Max clicks per user\n \"impressionInterval\": INTERVAL_VALUE, // Integer: Interval value (in h/d)\n \"impressionIntervalType\": \"INTERVAL_TYPE_H_OR_D\", // String: \"h\" = hours, \"d\" = days\n \"cappingType\": CAPPING_TYPE_0_OR_1 // Integer: 0 = user-level, 1 = app/site-level\n },\n\n \"optimisation\": { // (optional) Object: Optimisation settings\n \"type\": \"OPTIMISATION_TYPE_CPC_CTR_OR_CPA\", // String: One of \"CPC\", \"CTR\", or \"CPA\"\n \"target\": OPTIMISATION_TARGET, // Float: Target value\n \"impressions\": OPTIMISATION_IMPRESSIONS, // Integer: Min impressions before optimizing\n \"spent\": OPTIMISATION_SPENT // Float: Min spend before optimizing\n },\n\n \"preOptimisation\": PRE_OPTIMISATION_0_OR_2 // (optional) Integer: Pre-optimisation flag (0 or 2)\n}\n" }, "url": { "raw": "{{base_url}}v1/campaign/native/create", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "native", "create" ] } }, "response": [] }, { "name": "DeleteCampaign", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base_url}}v1/campaign/delete/{{CAMPAIGN_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "delete", "{{CAMPAIGN_ID}}" ] } }, "response": [] }, { "name": "GetCampaignList", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base_url}}v1/campaign/get?advertiserId=&page=1&per_page=15", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "get" ], "query": [ { "key": "advertiserId", "value": "", "description": "Advertiser ID of campaign owner." }, { "key": "page", "value": "1", "description": "Page number to fetch" }, { "key": "per_page", "value": "15", "description": "Items per page, max value 100" } ] } }, "response": [] }, { "name": "GetCampaignStatus", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base_url}}v1/campaign/status/get/{{CAMPAIGN_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "status", "get", "{{CAMPAIGN_ID}}" ] } }, "response": [] }, { "name": "CampaignStart", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/campaign/start/{{CAMPAIGN_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "start", "{{CAMPAIGN_ID}}" ] } }, "response": [] }, { "name": "StopCampaign", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/campaign/stop/{{CAMPAIGN_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "stop", "{{CAMPAIGN_ID}}" ] } }, "response": [] }, { "name": "UpdateBannerTypeCampaign", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"CAMPAIGN_NAME\", // (optional) String: Name of the campaign\n \"adDomain\": \"AD_DOMAIN\", // (optional) String: Domain/host of the campaign (e.g. \"eskimi.com\")\n \"clickUrl\": \"CLICK_URL\", // (optional) String: Click URL of the campaign\n\n \"dates\": { // (optional) Object: Campaign targeting dates\n \"from\": \"START_DATE\", // (optional) String: Start date (YYYY-MM-DD)\n \"to\": \"END_DATE\" // (optional) String: End date (YYYY-MM-DD)\n },\n\n \"bid\": BID_AMOUNT, // (optional) Float: Bid size between 0.1 and 10\n\n \"budget\": { // (optional) Object: Budget settings\n \"type\": \"BUDGET_TYPE_DAILY_OR_TOTAL\", // (optional) String: \"daily\" or \"total\"\n \"amount\": BUDGET_AMOUNT, // (optional) Number: Budget amount\n \"pacing\": PACING // (optional) Number: Pacing value\n },\n\n \"creativeIds\": [CREATIVE_IDS], // (optional) Array: List of creative IDs\n\n \"hours\": HOURS, // (optional) Object: Weekday targeting hours (1=Mon to 7=Sun), values [0-23]\n\n \"stateIds\": [STATE_IDS], // (optional) Array: Country state IDs\n \"operatorIds\": [OPERATOR_IDS], // (optional) Array: Mobile operator IDs\n \"exchangeIds\": [EXCHANGE_IDS], // (optional) Array: Exchange IDs\n\n \"exchangeSettings\": { // (optional) Object: Additional settings per exchange\n \"EXCHANGE_ID\": {\n \"page_id\": \"FACEBOOK_PAGE_ID\", // (optional) String: Facebook page ID\n \"object_story_id\": \"OBJECT_STORY_ID\", // (optional) String: Facebook object story ID\n \"budget_type\": \"daily\" // (optional) String: Facebook budget type (\"daily\", \"lifetime\")\n }\n },\n\n \"audienceIds\": [AUDIENCE_IDS], // (optional) Array: Audience IDs\n \"adPlacementTypeIds\": [PLACEMENT_TYPE_IDS], // (optional) Array: Ad placement type IDs\n \"privateMarketplaceIds\": [PRIVATE_MARKETPLACE_IDS], // (optional) Array: Private marketplace IDs\n\n \"wifi\": WIFI_0_OR_1, // (optional) Integer: Target WiFi only? 0 = No, 1 = Yes\n \"autoStart\": AUTO_START_0_OR_1, // (optional) Integer: Start campaign automatically? 0 = No, 1 = Yes\n \"device\": DEVICE, // (optional) Object: Device targeting (typeIds, osIds, etc.)\n \"capping\": CAPPING, // (optional) Object: Capping settings (e.g. impressions, clicks, intervals)\n \"optimisation\": OPTIMISATION, // (optional) Object: Optimisation settings (type, target, impressions, spent)\n \"preOptimisation\": PRE_OPTIMISATION // (optional) Integer: Pre-optimisation setting (0 or 2)\n}\n" }, "url": { "raw": "{{base_url}}v1/campaign/banner/update/{{CAMPAIGN_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "banner", "update", "{{CAMPAIGN_ID}}" ] } }, "response": [] }, { "name": "UpdateNativeTypeCampaign", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": campaign_name, // (optional) String: Name of the campaign\n \"adDomain\": ad_domain, // (optional) String: Domain/host of the campaign (e.g. eskimi.com)\n \"clickUrl\": click_url, // (optional) String: Click URL of the campaign\n\n \"dates\": { // Object: Campaign targeting dates\n \"from\": start_date, // String: Start date (YYYY-MM-DD), must be current or later\n \"to\": end_date // String: End date (YYYY-MM-DD), must be after start date\n },\n\n \"bid\": bid_amount, // Float: Bid size between 0.1 and 10\n\n \"budget\": { // Object: Budget details\n \"type\": budget_type, // String: daily or total\n \"amount\": budget_amount, // Number: Budget amount\n \"pacing\": pacing // Number: Pacing value\n },\n\n \"creativeIds\": [creative_id_1, creative_id_2], // (optional) Array: List of creative IDs\n\n \"hours\": { // (optional) Object: Map of targeting hours by weekday\n \"1\": [1, 2, 3, 4], \n \"2\": [5, 6, 7],\n \"3\": [8, 9, 10, 11],\n \"4\": [12, 13, 14, 15, 16],\n \"5\": [17, 18, 19, 20],\n \"6\": [21, 22],\n \"7\": [23]\n },\n\n \"stateIds\": [state_id_1, state_id_2], // (optional) Array: List of country state IDs\n \"operatorIds\": [operator_id_1], // (optional) Array: List of mobile operator IDs\n \"exchangeIds\": [exchange_id_1], // (optional) Array: List of exchange IDs\n\n \"audienceIds\": [audience_id_1], // (optional) Array: List of audience IDs\n \"adPlacementTypeIds\": [placement_type_id_1], // (optional) Array: List of ad placement type IDs\n \"privateMarketplaceIds\": [pmp_id_1], // (optional) Array: List of private marketplace IDs\n\n \"wifi\": wifi_flag, // (optional) Integer: 0 or 1 – target WiFi devices\n \"autoStart\": auto_start_flag, // (optional) Integer: 0 or 1 – auto-start campaign\n\n \"device\": { // (optional) Object: Device targeting options\n \"typeIds\": [device_type_id_1],\n \"connectionIds\": [connection_id_1],\n \"osIds\": [os_id_1],\n \"browserIds\": [browser_id_1]\n },\n\n \"capping\": { // (optional) Object: Campaign capping\n \"impressions\": impression_cap,\n \"clicks\": click_cap,\n \"impressionInterval\": impression_interval,\n \"impressionIntervalType\": interval_type, // \"h\" or \"d\"\n \"cappingType\": capping_type // 0 = User, 1 = App/Site\n },\n\n \"optimisation\": optimisation_data, // (optional) Object: Optimisation settings\n \"preOptimisation\": pre_optimisation // Integer: 0 or 2\n}\n" }, "url": { "raw": "{{base_url}}v1/campaign/native/update/{{CAMPAIGN_ID}}", "host": [ "{{base_url}}v1" ], "path": [ "campaign", "native", "update", "{{CAMPAIGN_ID}}" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Country", "item": [ { "name": "GetCountryList", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/country/get", "host": [ "{{base_url}}v1" ], "path": [ "country", "get" ] } }, "response": [] }, { "name": "GetStateList", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/country/states/get/{{COUNTRY_CODE}}", "host": [ "{{base_url}}v1" ], "path": [ "country", "states", "get", "{{COUNTRY_CODE}}" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Creative", "item": [ { "name": "CreateCreativeSet", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": advertiser_id, // Integer: The user ID\n \"title\": creative_set_title, // String: The title of the creative set\n \"creative_type_id\": 1 // Integer: 1 = Banner, 2 = Native (default: 1)\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}v1/creative/sets/create", "host": [ "{{base_url}}v1" ], "path": [ "creative", "sets", "create" ] } }, "response": [] }, { "name": "CreateCreative", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"advertiserId\": advertiser_id, // Integer: The user ID\n \"creativeSetId\": creative_set_id, // Integer: The Creative Set ID\n \"title\": creative_title // String: The title of creative\n}" }, "url": { "raw": "{{base_url}}v1/creative/create", "host": [ "{{base_url}}v1" ], "path": [ "creative", "create" ] } }, "response": [] }, { "name": "DeleteCreativeSet", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}v1/creative/sets/delete/{{creativeSetId}}", "host": [ "{{base_url}}v1" ], "path": [ "creative", "sets", "delete", "{{creativeSetId}}" ] } }, "response": [] }, { "name": "DeleteCreative", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/creative/delete/{{creativeId}}", "host": [ "{{base_url}}v1" ], "path": [ "creative", "delete", "{{creativeId}}" ] } }, "response": [] }, { "name": "GetCreativesSetlList", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/creative/sets/get?advertiserId=&page=1&per_page=15", "host": [ "{{base_url}}v1" ], "path": [ "creative", "sets", "get" ], "query": [ { "key": "advertiserId", "value": "", "description": "The ID of creative set owner" }, { "key": "page", "value": "1", "description": "Page number to fetch" }, { "key": "per_page", "value": "15", "description": "Item per page, max value 100" } ] } }, "response": [] }, { "name": "GetCreativeslList", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/creative/get?advertiserId=&creativeSetId=&page=1&per_page=15", "host": [ "{{base_url}}v1" ], "path": [ "creative", "get" ], "query": [ { "key": "advertiserId", "value": "", "description": "The ID of creative owner" }, { "key": "creativeSetId", "value": "", "description": "The ID of creative set" }, { "key": "page", "value": "1", "description": "Page number to fetch" }, { "key": "per_page", "value": "15", "description": "Items per page, max value 100" } ] } }, "response": [] }, { "name": "UpdateCreativeSet", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"creative_set_title\" // The title of creative set\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}v1/creative/sets/update/{{creativeSetId}}", "host": [ "{{base_url}}v1" ], "path": [ "creative", "sets", "update", "{{creativeSetId}}" ] } }, "response": [] }, { "name": "UpdateCreative", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"creative_set_title\" // The title of creative set\n}" }, "url": { "raw": "{{base_url}}v1/creative/sets/update/{{creativeSetId}}", "host": [ "{{base_url}}v1" ], "path": [ "creative", "sets", "update", "{{creativeSetId}}" ] } }, "response": [] }, { "name": "UploadCreativeAssetBannerType", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creativeId\": creative_id, // Integer: The ID of creative\n \"creativeFile\": base64_encoded_zip // String: Base64 encoded zip file. The archived file or multiple files must be in one of the following formats: .png, .jpg, .gif\n}" }, "url": { "raw": "{{base_url}}v1/creative/banner/upload", "host": [ "{{base_url}}v1" ], "path": [ "creative", "banner", "upload" ] } }, "response": [] }, { "name": "UploadCreativeAssetNativeType", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creativeId\": creative_id, // Integer: The ID of creative\n \"iconFile\": base64_encoded_zip_icon, // String: Base64 encoded zip file (.png, .jpg, .gif)\n \"imageMainFile\": base64_encoded_zip_image_main,// String: Base64 encoded zip file (.png, .jpg, .gif)\n \"image600x600File\": base64_encoded_zip_image_600x600, // String: Base64 encoded zip file (.png, .jpg, .gif)\n \"content\": {\n \"title\": content_title, // String: Content title\n \"desc\": content_desc_optional, // String: Description, e.g. Your home sweet Brooklyn home - cheaper and sooner than you think!\n \"desc2\": content_desc2_optional, // String: Additional description, e.g. Best place, best price only at Brooklyn home!\n \"cta\": content_cta_optional, // String: Call to action text, e.g. Install\n \"sponsored\": content_sponsored_optional, // String: Advertiser, e.g. NY Morgage Inc.\n \"likes\": content_likes_optional, // String: Likes, e.g. 100,000\n \"downloads\": content_downloads_optional, // String: Downloads, e.g. 100,000,000\n \"price\": content_price_optional, // String: Price, e.g. $1.99\n \"sale_price\": content_sale_price_optional, // String: Sale price, e.g. Free\n \"phone\": content_phone_optional, // String: Phone, e.g. +234 1 200 0000\n \"address\": content_address_optional, // String: Address, e.g. 459 Broadway FL 5, New York, NY 10013\n \"rating\": content_rating_optional, // String: Rating, e.g. 4.5\n \"display_url\": content_display_url_optional // String: Display URL, e.g. https://www.display-url-link.com\n }\n}" }, "url": { "raw": "{{base_url}}v1/creative/native/upload", "host": [ "{{base_url}}v1" ], "path": [ "creative", "native", "upload" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Device", "item": [ { "name": "GetDeviceBrands", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/device/brands/get?page=1&limit=15", "host": [ "{{base_url}}v1" ], "path": [ "device", "brands", "get" ], "query": [ { "key": "page", "value": "1", "description": "(optional) Current Page number default: 1" }, { "key": "limit", "value": "15", "description": "(optional) Per Page data limit default: 15" } ] } }, "response": [] }, { "name": "GetDeviceConnections", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base_url}}v1/device/connections/get", "host": [ "{{base_url}}v1" ], "path": [ "device", "connections", "get" ] } }, "response": [] }, { "name": "GetDeviceModelsByBrandID", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/device/models/get{{brandId}}?page=1&limit=15", "host": [ "{{base_url}}v1" ], "path": [ "device", "models", "get{{brandId}}" ], "query": [ { "key": "page", "value": "1", "description": "(optional) Current Page number default: 1" }, { "key": "limit", "value": "15", "description": "(optional) Per Page data limit default: 15" } ] } }, "response": [] }, { "name": "GetDeviceOSes", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/device/oses/get", "host": [ "{{base_url}}v1" ], "path": [ "device", "oses", "get" ] } }, "response": [] }, { "name": "GetDeviceTypes", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/device/types/get", "host": [ "{{base_url}}v1" ], "path": [ "device", "types", "get" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Exchanges", "item": [ { "name": "GetExchanges", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{base_url}}v1/exchanges/get", "host": [ "{{base_url}}v1" ], "path": [ "exchanges", "get" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Genders", "item": [ { "name": "GetGenders", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/genders/get", "host": [ "{{base_url}}v1" ], "path": [ "genders", "get" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Invoice", "item": [ { "name": "GetInvoiceDetailsByInvoiceNumber", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/invoice/{{serial_number}}", "host": [ "{{base_url}}v1" ], "path": [ "invoice", "{{serial_number}}" ] } }, "response": [] }, { "name": "GetInvoicePDFByInvoicenumber", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/invoice/{{serial_number}}/pdf", "host": [ "{{base_url}}v1" ], "path": [ "invoice", "{{serial_number}}", "pdf" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Operator", "item": [ { "name": "GetOperators", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}v1/operators/get/{{country}}?country", "host": [ "{{base_url}}v1" ], "path": [ "operators", "get", "{{country}}" ], "query": [ { "key": "country", "value": null, "description": "ISO 3166-2 alpha-2 two-letter lowercase country code." } ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "PrivateMarketplace", "item": [ { "name": "GetPrivateMarketplaces", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/privateMarketplace/get?advertiserId=", "host": [ "{{base_url}}v1" ], "path": [ "privateMarketplace", "get" ], "query": [ { "key": "advertiserId", "value": "", "description": "The advertiser ID" } ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Report", "item": [ { "name": "GetAdReportByAdPlacementPosition", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/adPlacementPositions/get?advertiserId=&byDate=0&byCampaign=0&placementPositionId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "adPlacementPositions", "get" ], "query": [ { "key": "advertiserId", "value": "", "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "placementPositionId", "value": null, "description": "The ad placement position id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD). Default value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD). Default value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign IDs." } ] } }, "response": [] }, { "name": "GetAdReportByAdPlacementType", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/adPlacementTypes/get?advertiserId=&byDate=0&byCampaign=0&placementTypeId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "adPlacementTypes", "get" ], "query": [ { "key": "advertiserId", "value": "", "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "placementTypeId", "value": null, "description": "The placement type id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign IDs." } ] } }, "response": [] }, { "name": "GetCampaignReportByAgeGroups", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/ageGroups/get?advertiserId=&campaignIds[]=&byDate=0&byCampaign=0&dateFrom=&dateTo=&ageGroupId=", "host": [ "{{base_url}}v1" ], "path": [ "report", "ageGroups", "get" ], "query": [ { "key": "advertiserId", "value": "", "description": "The advertiser ID." }, { "key": "campaignIds[]", "value": "", "description": "The campaign IDs." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "dateFrom", "value": "", "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": "", "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "ageGroupId", "value": "", "description": "The age group id, if provided, result will filtered by that id." } ] } }, "response": [] }, { "name": "GetCampaignReportByBrowser", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/browsers/get?advertiserId&byDate=0&byCampaign=0&browserId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "browsers", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "browserId", "value": null, "description": "The browser id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign IDs." } ] } }, "response": [] }, { "name": "GetCampaignReportByCreative", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/creatives/get?advertiserId&byDate=0&byCampaign=0&creativeId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "creatives", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "creativeId", "value": null, "description": "The creative id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign IDs." } ] } }, "response": [] }, { "name": "GetCampaignReportByExchange", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/exchanges/get?advertiserId&byDate=0&byCampaign=0&exchangeId=&dateFrom=&dateTo=&campaignIds[]=", "host": [ "{{base_url}}v1" ], "path": [ "report", "exchanges", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "exchangeId", "value": "", "description": "The exchange id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": "", "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": "", "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": "", "description": "The campaign IDs." } ] } }, "response": [] }, { "name": "GetCampaignReportByGender", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}v1/report/genders/get?advertiserId&byDate=0&byCampaign=0&genderId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "genders", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "genderId", "value": null, "description": "The gender id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign IDs." } ] } }, "response": [] }, { "name": "GetCampaignReportByOperatingSystem", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/oses/get?advertiserId&byDate=0&byCampaign=0&osId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "oses", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. Should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. Should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "osId", "value": null, "description": "The operating system id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign ID." } ] } }, "response": [] }, { "name": "GetCampaignReportByOperator", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/operators/get?advertiserId&byDate=0&byCampaign=0&operatorId=&dateFrom=&dateTo=&campaignIds[]=", "host": [ "{{base_url}}v1" ], "path": [ "report", "operators", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID." }, { "key": "byDate", "value": "0", "description": "Group by date. Should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. Should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "operatorId", "value": "", "description": "The operator id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": "", "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": "", "description": "Group by date. should the result grouped by date. Values can be 0 or 1.\n\nDefault value: 0" }, { "key": "campaignIds[]", "value": "", "description": "The campaign IDs." } ] } }, "response": [] }, { "name": "GetCampaignReportBySitePlatforms", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/sitePlatforms/get?advertiserId&byDate=0&byCampaign=0&sitePlatformId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "sitePlatforms", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID" }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "sitePlatformId", "value": null, "description": "The site platform id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign IDs.\n\n" } ] } }, "response": [] }, { "name": "GetCampaignReportBySiteTypes", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/siteTypes/get?advertiserId&byDate=0&byCampaign=0&siteTypeId&dateFrom&dateTo&campaignIds[]", "host": [ "{{base_url}}v1" ], "path": [ "report", "siteTypes", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID" }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "siteTypeId", "value": null, "description": "The site type id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": null, "description": "The campaign ids" } ] } }, "response": [] }, { "name": "GetCampaignReportBySites", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/sites/get?advertiserId&campaignIds[]=&byDate=0&siteId=&dateFrom=&byCampaign=0&dateTo=", "host": [ "{{base_url}}v1" ], "path": [ "report", "sites", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID" }, { "key": "campaignIds[]", "value": "", "description": "The campaign IDs." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1.\nDefault value: 0" }, { "key": "siteId", "value": "", "description": "The site id, if provided, result will filtered by that id." }, { "key": "dateFrom", "value": "", "description": "The start date. format: (YYYY-MM-DD).\nDefault value: -7 days from current date" }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1.\n\nDefault value: 0" }, { "key": "dateTo", "value": "", "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" } ] } }, "response": [] }, { "name": "GetCampaignReport", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/campaigns/get?advertiserId&dateFrom=&dateTo=&campaignIds[]=&byCampaign=0&byDate=0", "host": [ "{{base_url}}v1" ], "path": [ "report", "campaigns", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID" }, { "key": "dateFrom", "value": "", "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": "", "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": "", "description": "The campaign IDs." }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1." } ] } }, "response": [] }, { "name": "GetDeviceIDsCampaignReport", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/deviceIds/get?advertiserId&campaignId&dateFrom&dateTo", "host": [ "{{base_url}}v1" ], "path": [ "report", "deviceIds", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID" }, { "key": "campaignId", "value": null, "description": "The campaign ID" }, { "key": "dateFrom", "value": null, "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": null, "description": "The end date. format: (YYYY-MM-DD).\n\nDefault value: CURRENT_DATE" } ] } }, "response": [] }, { "name": "GetVideoCampaignReport", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/report/videoCampaigns/get?advertiserId&byDate=0&byCampaign=0&dateFrom=&dateTo=&campaignIds[]=", "host": [ "{{base_url}}v1" ], "path": [ "report", "videoCampaigns", "get" ], "query": [ { "key": "advertiserId", "value": null, "description": "The advertiser ID" }, { "key": "byDate", "value": "0", "description": "Group by date. should the result grouped by date. Values can be 0 or 1" }, { "key": "byCampaign", "value": "0", "description": "Group by campaign. should the result grouped by campaign id. Values can be 0 or 1." }, { "key": "dateFrom", "value": "", "description": "The start date. format: (YYYY-MM-DD).\n\nDefault value: -7 days from current date" }, { "key": "dateTo", "value": "", "description": "The end date. format: (YYYY-MM-DD). Default value: CURRENT_DATE" }, { "key": "campaignIds[]", "value": "", "description": "The campaign IDs" } ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Sites", "item": [ { "name": "GetSitePlatforms", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/sites/platforms/get", "host": [ "{{base_url}}v1" ], "path": [ "sites", "platforms", "get" ] } }, "response": [] }, { "name": "GetSiteTypes", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/sites/types/get", "host": [ "{{base_url}}v1" ], "path": [ "sites", "types", "get" ] } }, "response": [] }, { "name": "GetSites", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{ACCESS_TOKEN}}", "type": "text" } ], "url": { "raw": "{{base_url}}v1/sites/get", "host": [ "{{base_url}}v1" ], "path": [ "sites", "get" ] } }, "response": [] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "New Request", "request": { "method": "GET", "header": [] }, "response": [] } ] }