Etarget Api
Methods:
Agency
customersStatsgetAccessTokengetCustomersCustomer
extraReachgetAccessTokengetPPCCampaignDailyStatsgetPPCCampaignStatsgetPPCCampaignsgetPPCCampaignsFullgetRTBCampaignCreativesgetRTBCampaignDailyStatsgetRTBCampaignStatsgetRTBCampaignsgetRTBCreativeDailyStatsgetRTBCreativeStatsgetRTBSiteDailyStatsgetRTBSiteStatsExcel
getActiveCampaignStatsgetCreditSpendgetCustomerSpendPartner
createPartnergetAccessTokengetExternalPublisherStatsgetPartnergetPartnerDashboardDatagetPartnerPaymentInvoicegetPartnerPaymentStatsgetPortalStatsupdatePartnerAgency
customersStats
Path: https://api.etarget.cz/agency/customersStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getAccessToken
Path: https://api.etarget.cz/agency/getAccessToken
HTTP Method: GET
Accept: application/json
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
getCustomers
Path: https://api.etarget.cz/agency/getCustomers
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
CampaignFullStats
Path: https://api.etarget.cz/CampaignFullStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| include_versions | integer | N | Set to 1 to retrieve camapign versinon stats. Default 0 |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
CustomOMGStats
Path: https://api.etarget.cz/CustomOMGStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| include_versions | integer | N | Set to 1 to retrieve camapign versinon stats. Default 0 |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
Customer
extraReach
Path: https://api.etarget.cz/customer/extraReach
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| campaign_name | string | Y | |
| action | string | Y | |
| source | string | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
getAccessToken
Path: https://api.etarget.cz/customer/getAccessToken
HTTP Method: GET
Accept: application/json
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
getPPCCampaignDailyStats
Path: https://api.etarget.cz/customer/getPPCCampaignDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| include_versions | integer | N | Set to 1 to retrieve camapign versinon stats. Default 0 |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getPPCCampaignStats
Path: https://api.etarget.cz/customer/getPPCCampaignStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| include_versions | integer | N | Set to 1 to retrieve camapign versinon stats. Default 0 |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getPPCCampaigns
Path: https://api.etarget.cz/customer/getPPCCampaigns
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getPPCCampaignsFull
Path: https://api.etarget.cz/customer/getPPCCampaignsFull
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBCampaignCreatives
Path: https://api.etarget.cz/customer/getRTBCampaignCreatives
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_id | integer | Y | Campaign ID. |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBCampaignDailyStats
Path: https://api.etarget.cz/customer/getRTBCampaignDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBCampaignStats
Path: https://api.etarget.cz/customer/getRTBCampaignStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBCampaigns
Path: https://api.etarget.cz/customer/getRTBCampaigns
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBCreativeDailyStats
Path: https://api.etarget.cz/customer/getRTBCreativeDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| creative_ids | string | N | Comma-separated list of integers. |
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBCreativeStats
Path: https://api.etarget.cz/customer/getRTBCreativeStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| creative_ids | string | N | Comma-separated list of integers. |
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBSiteDailyStats
Path: https://api.etarget.cz/customer/getRTBSiteDailyStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| site_refs | string | N | Comma-separated list of integers. |
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
getRTBSiteStats
Path: https://api.etarget.cz/customer/getRTBSiteStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| site_refs | string | N | Comma-separated list of integers. |
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
excel
getActiveCampaignStats
Path: https://api.etarget.cz/excel/getActiveCampaignStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| excel_token | string | Y | Contact us to get your token |
| time_from | timestamp | N | Start date of the statistics.(d.m.Y or timestamp) |
| last | integer | N | Last X days of stats |
| exportTo | string | N | Accepted values are: html, json. Default html |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
excel
getCreditSpend
Path: https://api.etarget.cz/excel/getCreditSpend
HTTP Method: GET
Accept: application/json
Query Parameters:
| excel_token | string | Y | Contact us to get your token |
| time_from | timestamp | N | Start date of the statistics.(d.m.Y or timestamp) |
| group_by | string | N | Group by customer/campaign type/campaign/creative |
| last | integer | N | Last X days of stats |
| exportTo | string | N | Accepted values are: html, json. Default html |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
excel
getCustomerSpend
Path: https://api.etarget.cz/excel/getCustomerSpend
HTTP Method: GET
Accept: application/json
Query Parameters:
| excel_token | string | Y | Contact us to get your token |
| time_from | timestamp | N | Start date of the statistics.(d.m.Y or timestamp) |
| group_by | string | N | Group by customer/campaign type/campaign/creative |
| last | integer | N | Last X days of stats |
| exportTo | string | N | Accepted values are: html, json. Default html |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
KeywordFullStats
Path: https://api.etarget.cz/KeywordFullStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| customer_id | integer | Y | Customer ID. |
| campaign_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| include_versions | integer | N | Set to 1 to retrieve camapign versinon stats. Default 0 |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
MarvaxCleanDB
Path: https://api.etarget.cz/MarvaxCleanDB
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxCreateBanner
Path: https://api.etarget.cz/MarvaxCreateBanner
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| url | string | Y | |
| name | string | N | |
| marvax_customer_id | integer | N | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxCreateCampaign
Path: https://api.etarget.cz/MarvaxCreateCampaign
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
| banner_id | integer | Y | |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| schedule | string | N | |
| amount | integer | Y | |
| country_code | string | Y | |
| region_codes | string | N | |
| content_categroy_id | integer | N | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxCreateCustomer
Path: https://api.etarget.cz/MarvaxCreateCustomer
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
| email | string | N | |
| sex | integer | N | |
| telephone | string | N | |
| url | string | N | |
| first_name | string | N | |
| last_name | string | N | |
| street | string | N | |
| zip | string | N | |
| city | string | N | |
| country | string | N | |
| ico | string | N | |
| icdph | string | N | |
| dic | string | N | |
| language | string | N | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetBanner
Path: https://api.etarget.cz/MarvaxGetBanner
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| banner_id | integer | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetBannerInteractionStats
Path: https://api.etarget.cz/MarvaxGetBannerInteractionStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_ids | string | N | Comma-separated list of integers. |
| banner_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetBanners
Path: https://api.etarget.cz/MarvaxGetBanners
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_ids | string | N | Comma-separated list of integers. |
| banner_ids | string | N | Comma-separated list of integers. |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetCustomer
Path: https://api.etarget.cz/MarvaxGetCustomer
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetCustomerInteractionStats
Path: https://api.etarget.cz/MarvaxGetCustomerInteractionStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetCustomerInvoices
Path: https://api.etarget.cz/MarvaxGetCustomerInvoices
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetCustomerRemainingFreeImpressions
Path: https://api.etarget.cz/MarvaxGetCustomerRemainingFreeImpressions
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetCustomers
Path: https://api.etarget.cz/MarvaxGetCustomers
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_ids | string | N | Comma-separated list of integers. |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetDailyBannerInteractionStats
Path: https://api.etarget.cz/MarvaxGetDailyBannerInteractionStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_ids | string | N | Comma-separated list of integers. |
| banner_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetDailyCustomerInteractionStats
Path: https://api.etarget.cz/MarvaxGetDailyCustomerInteractionStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetFeed
Path: https://api.etarget.cz/MarvaxGetFeed
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| feed_id | integer | Y | |
| limit | integer | N | |
| no_video | integer | N | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxGetFeeds
Path: https://api.etarget.cz/MarvaxGetFeeds
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| feed_ids | string | N | Comma-separated list of integers. |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxLinkBannerToCustomer
Path: https://api.etarget.cz/MarvaxLinkBannerToCustomer
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| banner_id | integer | Y | |
| marvax_customer_id | integer | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxNoteCardAddedToCustomer
Path: https://api.etarget.cz/MarvaxNoteCardAddedToCustomer
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxNoteCardRemovedFromCustomer
Path: https://api.etarget.cz/MarvaxNoteCardRemovedFromCustomer
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxStartCampaign
Path: https://api.etarget.cz/MarvaxStartCampaign
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
| campaign_id | integer | Y | Campaign ID. |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxStopCampaign
Path: https://api.etarget.cz/MarvaxStopCampaign
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
| campaign_id | integer | Y | Campaign ID. |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxUpdateBanner
Path: https://api.etarget.cz/MarvaxUpdateBanner
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| banner_id | integer | Y | |
| marvax_customer_id | integer | Y | |
| name | string | N | |
| is_fixed | bool | N | |
| post_ids | string | N | Comma-separated list of integers. |
| show_last_post_cnt | integer | N | |
| show_post_without_img | bool | N | |
| status | integer | N | 1 - active, 2 - inactive |
| click_url | string | N | |
| show_max_days | integer | N | |
| new_post_notify | bool | N | |
| new_post_notify_email | string | N | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxUpdateCampaign
Path: https://api.etarget.cz/MarvaxUpdateCampaign
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
| campaign_id | integer | Y | Campaign ID. |
| time_from | timestamp | N | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | N | End date of the statistics.(d.m.Y or timestamp) |
| schedule | string | N | |
| amount | integer | N | |
| country_code | string | N | |
| region_codes | string | N | |
| content_categroy_id | integer | N | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxUpdateCustomer
Path: https://api.etarget.cz/MarvaxUpdateCustomer
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| marvax_customer_id | integer | Y | |
| email | string | N | |
| sex | integer | N | |
| telephone | string | N | |
| url | string | N | |
| first_name | string | N | |
| last_name | string | N | |
| street | string | N | |
| zip | string | N | |
| city | string | N | |
| country | string | N | |
| ico | string | N | |
| icdph | string | N | |
| dic | string | N | |
| language | string | N | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
MarvaxUpdateUserInteraction
Path: https://api.etarget.cz/MarvaxUpdateUserInteraction
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| banner_id | integer | Y | |
| marvax_customer_id | integer | Y | |
| interaction_type | integer | Y | 1 - VIEW, 2 - MOUSE_OVER, 3 - ARROW, 4 - CLICK, 5 - MEASURABLE_VIEW, 6 - MEASURED_VIEW |
| interaction_url | string | Y | |
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
Partner
createPartner
Path: https://api.etarget.cz/partner/createPartner
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| email | string | Y | |
| login | string | Y | |
| pass | string | Y | |
| s_contact_telephone | string | Y | |
| o_name | string | Y | |
| typ_klienta | integer | Y | |
| name | string | N | |
| reg_num | string | N | |
| s_street | string | Y | |
| s_city | string | Y | |
| s_zip | string | Y | |
| s_country | string | Y | |
| s_bank_account_number | string | Y | |
Successful Response:
| 200 | application/json | json data |
Error Response:
| 400 | string | Error description |
getAccessToken
Path: https://api.etarget.cz/partner/getAccessToken
HTTP Method: GET
Accept: application/json
Successful Response:
| 200 | application/json | string |
Error Response:
| 400 | string | Error description |
getExternalPublisherStats
Path: https://api.etarget.cz/partner/getExternalPublisherStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| partner_id | integer | N | Partner ID |
| publisher_id | integer | N | |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
Error Response:
| 400 | string | Error description |
getPartner
Path: https://api.etarget.cz/partner/getPartner
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| partner_id | integer | N | Partner ID |
Successful Response:
| 200 | application/json | json data |
Error Response:
| 400 | string | Error description |
getPartnerDashboardData
Path: https://api.etarget.cz/partner/getPartnerDashboardData
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| partner_id | integer | N | Partner ID |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
Successful Response:
| 200 | application/json | json data |
Error Response:
| 400 | string | Error description |
getPartnerPaymentInvoice
Path: https://api.etarget.cz/partner/getPartnerPaymentInvoice
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| partner_id | integer | N | Partner ID |
| invoice | string | N | |
Successful Response:
| 200 | application/json | json data |
Error Response:
| 400 | string | Error description |
getPartnerPaymentStats
Path: https://api.etarget.cz/partner/getPartnerPaymentStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| partner_id | integer | N | Partner ID |
Successful Response:
| 200 | application/json | json data |
Error Response:
| 400 | string | Error description |
getPortalStats
Path: https://api.etarget.cz/partner/getPortalStats
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| partner_id | integer | N | Partner ID |
| portal_ids | string | N | Comma-separated list of integers. |
| time_from | timestamp | Y | Start date of the statistics.(d.m.Y or timestamp) |
| time_to | timestamp | Y | End date of the statistics.(d.m.Y or timestamp) |
| page | integer | N | Page number. If not provided, defaults to 1. |
| page_size | integer | N | Number of records per page. If not provided, defaults to 100. Maximum value is 1000. |
Error Response:
| 400 | string | Error description |
updatePartner
Path: https://api.etarget.cz/partner/updatePartner
HTTP Method: GET
Accept: application/json
Query Parameters:
| access_token | string | Y | Obtained by getAccessToken call |
| partner_id | integer | Y | Partner ID |
| s_password | string | N | |
| s_contact_name | string | N | |
| s_contact_telephone | string | N | |
| s_email | string | N | |
| s_name | string | N | |
| s_ico | string | N | |
| s_ic_dph | string | N | |
| s_street | string | N | |
| s_city | string | N | |
| s_zip | string | N | |
| s_country | string | N | |
| s_iban_number | string | N | |
Successful Response:
| 200 | application/json | json data |
Error Response:
| 400 | string | Error description |
Representation:
Paginated List
| totalCount | integer | Total number of items in the list, for all pages |
| pagination | Pagination | Pagination information |
| results | Array of Entity Statistics | Array of returned statistics paired with respective entities |
Pagination
| page | integer | Page number |
| page_size | integer | Number of items per page |
PPC Campaign stats
| time | timestamp | Only in daily stats. |
| customer_id | integer | Customer ID |
| campaign_id | integer | Campaign ID |
| views | integer | |
| clicks | integer | |
| ctr | float | Click-Through Rate |
| cpm | float | Cost per 1000 views |
| cpc | float | Cost per click |
| amount | float | Cost in local currency |
| version_stats | array | Campaign version stats |
RTB Campaign stats
| time | timestamp | Only in daily stats. |
| customer_id | integer | Customer ID |
| campaign_id | integer | Campaign ID |
| creative_id | integer | Creative ID. Only in Creative stats. |
| site_ref | text | Site ID.Only in Site stats. |
| domain | text | Domian, only in Site stats. |
| impressions_bid | integer | Number of bids |
| impressions_won | integer | Number of won bids(views) |
| clicks | integer | |
| ctr | float | Click-Through Rate |
| cpm | float | Cost per 1000 views |
| cpc | float | Cost per click |
| amount | float | Cost in local currency |
Customer
| customer_id | integer | Customer ID |
| name | string | Customer name. |
| status | integer | Customer status 1-online, 2-offline, 3-banned, 255-deleted |
Campaign (Basic view)
| campaign_id | integer | Campaign ID |
| name | string | Campaign name. |
| status | integer | Campaign status 1-online, 2-offline, 3-banned, 4-deleted |
Creative
| creative_id | integer | Creative ID |
| status | integer | Creative status 1-online, 2-offline, 3-banned, 4-deleted |
| width | integer | |
| height | integer | |
| img_url | string | URL of the image, Flash movie |
PPC Campaign (Full view)
| campaign_id | integer | Campaign ID |
| name | string | Campaign name. |
| campaign_body | array | Array of Campaign Ads |
| status | integer | Campaign status 1-online, 2-offline, 3-banned, 4-deleted |
| targeting_type | integer | Campaign targeting type, 1-broad, 2-retarget, 3-keyword, 4-category |
Campaign Ad
| title | string | Ad title |
| line1 | string | First line of the Ad. |
| line2 | string | Second line of the Ad. |
| url | string | Shown url |
| real_url | string | Click url |
| version_status | integer | Ad status 1-online, 2-offline |
| logo | array | Array containing Logo data. |
Logo
| logo_id | integer | Id |
| url | string | Image url |
Portal Stats
| partner_id | integer | Partner ID |
| portal_id | integer | Portal ID |
| name | integer | Portal name |
| url | integer | Portal url |
| views | integer | |
| clicks | integer | |
| ctr | float | Click-Through Rate |
| cpc | float | Cost per click |
| cpm | float | Cost per 1000 views |
| amount | float | Cost in local currency |
External Publisher Stats
| status | string | Pending/Ready |
| message | string | |
| report | csv | stats |
