Etarget Api

Methods:

Agency

customersStats
getAccessToken
getCustomers

Customer

extraReach
getAccessToken
getPPCCampaignDailyStats
getPPCCampaignStats
getPPCCampaigns
getPPCCampaignsFull
getRTBCampaignCreatives
getRTBCampaignDailyStats
getRTBCampaignStats
getRTBCampaigns
getRTBCreativeDailyStats
getRTBCreativeStats
getRTBSiteDailyStats
getRTBSiteStats

Partner

getAccessToken
getPortalStats

Agency

customersStats

Path: https://api.etarget.pl/agency/customersStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of Customers
Error Response:
Status CodeError BodyDescription
400stringError description
customersStats

getAccessToken

Path: https://api.etarget.pl/agency/getAccessToken
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
loginstringY
pswstringY
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonstring
Error Response:
Status CodeError BodyDescription
400stringError description
getAccessToken

getCustomers

Path: https://api.etarget.pl/agency/getCustomers
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of Customers
Error Response:
Status CodeError BodyDescription
400stringError description
getCustomers

CampaignFullStats

Path: https://api.etarget.pl/CampaignFullStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
include_versionsintegerNSet to 1 to retrieve camapign versinon stats. Default 0
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of PPC Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
CampaignFullStats

CustomOMGStats

Path: https://api.etarget.pl/CustomOMGStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
include_versionsintegerNSet to 1 to retrieve camapign versinon stats. Default 0
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of PPC Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
CustomOMGStats

Customer

extraReach

Path: https://api.etarget.pl/customer/extraReach
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
campaign_namestringY
actionstringY
sourcestringY
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonstring
Error Response:
Status CodeError BodyDescription
400stringError description
extraReach

getAccessToken

Path: https://api.etarget.pl/customer/getAccessToken
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
loginstringY
pswstringY
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonstring
Error Response:
Status CodeError BodyDescription
400stringError description
getAccessToken

getPPCCampaignDailyStats

Path: https://api.etarget.pl/customer/getPPCCampaignDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
include_versionsintegerNSet to 1 to retrieve camapign versinon stats. Default 0
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of PPC Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getPPCCampaignDailyStats

getPPCCampaignStats

Path: https://api.etarget.pl/customer/getPPCCampaignStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
include_versionsintegerNSet to 1 to retrieve camapign versinon stats. Default 0
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of PPC Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getPPCCampaignStats

getPPCCampaigns

Path: https://api.etarget.pl/customer/getPPCCampaigns
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of Campaigns (Basic view)
Error Response:
Status CodeError BodyDescription
400stringError description
getPPCCampaigns

getPPCCampaignsFull

Path: https://api.etarget.pl/customer/getPPCCampaignsFull
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of PPC Campaigns (Full view)
Error Response:
Status CodeError BodyDescription
400stringError description
getPPCCampaignsFull

getRTBCampaignCreatives

Path: https://api.etarget.pl/customer/getRTBCampaignCreatives
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idintegerYCampaign ID.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of Creatives
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBCampaignCreatives

getRTBCampaignDailyStats

Path: https://api.etarget.pl/customer/getRTBCampaignDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of RTB Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBCampaignDailyStats

getRTBCampaignStats

Path: https://api.etarget.pl/customer/getRTBCampaignStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of RTB Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBCampaignStats

getRTBCampaigns

Path: https://api.etarget.pl/customer/getRTBCampaigns
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of Campaigns (Basic view)
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBCampaigns

getRTBCreativeDailyStats

Path: https://api.etarget.pl/customer/getRTBCreativeDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
creative_idsstringNComma-separated list of integers.
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of RTB Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBCreativeDailyStats

getRTBCreativeStats

Path: https://api.etarget.pl/customer/getRTBCreativeStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
creative_idsstringNComma-separated list of integers.
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of RTB Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBCreativeStats

getRTBSiteDailyStats

Path: https://api.etarget.pl/customer/getRTBSiteDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
site_refsstringNComma-separated list of integers.
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of RTB Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBSiteDailyStats

getRTBSiteStats

Path: https://api.etarget.pl/customer/getRTBSiteStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
site_refsstringNComma-separated list of integers.
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of RTB Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
getRTBSiteStats

KeywordFullStats

Path: https://api.etarget.pl/KeywordFullStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
customer_idintegerYCustomer ID.
campaign_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
include_versionsintegerNSet to 1 to retrieve camapign versinon stats. Default 0
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of PPC Campaign stats
Error Response:
Status CodeError BodyDescription
400stringError description
KeywordFullStats

Partner

getAccessToken

Path: https://api.etarget.pl/partner/getAccessToken
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
loginstringY
pswstringY
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonstring
Error Response:
Status CodeError BodyDescription
400stringError description
getAccessToken

getPortalStats

Path: https://api.etarget.pl/partner/getPortalStats
HTTP Method: GET
Accept: application/json
Query Parameters:
ParameterTypeRequiredDescription
access_tokenstringYObtained by getAccessToken call
partner_idintegerNArea ID
portal_idsstringNComma-separated list of integers.
time_fromtimestampYStart date of the statistics.
time_totimestampYEnd date of the statistics.
pageintegerNPage number. If not provided, defaults to 1.
page_sizeintegerNNumber of records per page. If not provided, defaults to 100. Maximum value is 1000.
Successful Response:
Status CodeContent-TypeRepresentation
200application/jsonPaginated List of Portal stats
Error Response:
Status CodeError BodyDescription
400stringError description
getPortalStats

Representation:

Paginated List

FieldTypeDescription
totalCountintegerTotal number of items in the list, for all pages
paginationPaginationPagination information
resultsArray of Entity StatisticsArray of returned statistics paired with respective entities

Pagination

FieldTypeDescription
pageintegerPage number
page_sizeintegerNumber of items per page

PPC Campaign stats

FieldTypeDescription
timetimestampOnly in daily stats.
customer_idintegerCustomer ID
campaign_idintegerCampaign ID
viewsinteger
clicksinteger
ctrfloatClick-Through Rate
cpmfloatCost per 1000 views
cpcfloatCost per click
amountfloatCost in local currency
version_statsarrayCampaign version stats

RTB Campaign stats

FieldTypeDescription
timetimestampOnly in daily stats.
customer_idintegerCustomer ID
campaign_idintegerCampaign ID
creative_idintegerCreative ID. Only in Creative stats.
site_reftextSite ID.Only in Site stats.
domaintextDomian, only in Site stats.
impressions_bidintegerNumber of bids
impressions_wonintegerNumber of won bids(views)
clicksinteger
ctrfloatClick-Through Rate
cpmfloatCost per 1000 views
cpcfloatCost per click
amountfloatCost in local currency

Customer

FieldTypeDescription
customer_idintegerCustomer ID
namestringCustomer name.
statusintegerCustomer status 1-online, 2-offline, 3-banned, 255-deleted

Campaign (Basic view)

FieldTypeDescription
campaign_idintegerCampaign ID
namestringCampaign name.
statusintegerCampaign status 1-online, 2-offline, 3-banned, 4-deleted

Creative

FieldTypeDescription
creative_idintegerCreative ID
statusintegerCreative status 1-online, 2-offline, 3-banned, 4-deleted
widthinteger
heightinteger
img_urlstringURL of the image, Flash movie

PPC Campaign (Full view)

FieldTypeDescription
campaign_idintegerCampaign ID
namestringCampaign name.
campaign_bodyarrayArray of Campaign Ads
statusintegerCampaign status 1-online, 2-offline, 3-banned, 4-deleted
targeting_typeintegerCampaign targeting type, 1-broad, 2-retarget, 3-keyword, 4-category

Campaign Ad

FieldTypeDescription
titlestringAd title
line1stringFirst line of the Ad.
line2stringSecond line of the Ad.
urlstringShown url
real_urlstringClick url
version_statusintegerAd status 1-online, 2-offline
logoarrayArray containing Logo data.

Logo

FieldTypeDescription
logo_idintegerId
urlstringImage url

Portal Stats

FieldTypeDescription
partner_idintegerPartner ID
portal_idintegerPortal ID
nameintegerPortal name
urlintegerPortal url
viewsinteger
clicksinteger
ctrfloatClick-Through Rate
cpcfloatCost per click
cpmfloatCost per 1000 views
amountfloatCost in local currency
Co to jest Etarget?

Etarget - sieć reklamy kontekstowej. Zaletą jest darmowa emisja. Kilka groszy zapłacicie dopiero za klik - czyli za użytkownika Waszej strony.

W Polsce współpracujemy z ponad 550 partnerskimi stronami.    © 2002 - 2017 ETARGET SE