{
"openapi": "3.0.0",
"info": {
"title": "Daisycon API",
"description": "Daisycon API",
"termsOfService": "https://daisycon.com/en/general-terms-and-conditions-publishers/",
"contact": {
"email": "api@daisycon.com"
},
"version": "2.0.0"
},
"servers": [
{
"url": "https://services.daisycon.com"
}
],
"paths": {
"/advertisers/{advertiser_id}/businessinfo": {
"get": {
"tags": [
"/advertisers/businessinfo"
],
"summary": "Get the advertiser business information",
"description": "Returns the advertiser business information",
"operationId": "getAdvertiserAccountBusinessInfo",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_businessinfo"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/businessinfo"
],
"summary": "Update the advertiser business information",
"description": "Update the advertiser business information",
"operationId": "updateAdvertiserAccountBusinessInfo",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_businessinfo_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_businessinfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/businessinfo"
],
"summary": "Add the advertiser business information",
"description": "Add the advertiser business information, and set the advertiser account type as business",
"operationId": "createAdvertiserAccountBusinessInfo",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_businessinfo_update"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_businessinfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/businessinfo/history": {
"get": {
"tags": [
"/advertisers/businessinfo"
],
"summary": "Get the advertiser business information history",
"description": "Returns the advertiser business information history",
"operationId": "getAllHistoryAdvertiserAccountBusinessInfo",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_businessinfo"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/businessinfo/history/{history_id}": {
"get": {
"tags": [
"/advertisers/businessinfo"
],
"summary": "Get the advertiser business information history by id",
"description": "Returns the advertiser business information history by id",
"operationId": "getHistoryAdvertiserAccountBusinessInfo",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/history_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_businessinfo"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/address": {
"get": {
"tags": [
"/advertisers/address"
],
"summary": "Get advertiser address",
"description": "Returns advertiser address",
"operationId": "getAddressAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_address"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/address"
],
"summary": "Update advertiser address",
"description": "Update advertiser address",
"operationId": "putAddressAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_address_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_address"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/address"
],
"summary": "Add advertiser address",
"description": "Add advertiser address. Country ID is required. For Dutch addresses the postal_code andhouse_number are required and house_number_additive is optional. For other countries address_line_1 isrequired and address_line_2 is optional.",
"operationId": "postAddressAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_address_update"
}
}
}
},
"responses": {
"201": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_address"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/address/history": {
"get": {
"tags": [
"/advertisers/address"
],
"summary": "Get advertiser address history",
"description": "Returns address from the history table",
"operationId": "getAddressHistoryAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_address_history"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/address/history/{history_id}": {
"get": {
"tags": [
"/advertisers/address"
],
"summary": "Get advertiser address history",
"description": "Returns address from the history table",
"operationId": "getAddressHistoryByIdAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/history_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_address_history"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/agreementterms": {
"get": {
"tags": [
"/advertisers/agreementterms"
],
"summary": "Get all agreement terms",
"description": "Returns a set of agreement terms",
"operationId": "getAllAdvertiserAgreement",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_agreement_terms_id"
},
{
"$ref": "#/components/parameters/filter_questionnaire_id"
},
{
"$ref": "#/components/parameters/filter_language_id"
},
{
"$ref": "#/components/parameters/filter_content"
},
{
"$ref": "#/components/parameters/filter_agreement_terms_date"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agreement_terms"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/agreementterms/{agreement_terms_id}": {
"get": {
"tags": [
"/advertisers/agreementterms"
],
"summary": "Get an agreement term",
"description": "Returns an agreement term",
"operationId": "getAdvertiserAgreement",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/agreement_terms_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/agreement_terms"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/agreementterms/publishers/{publisher_id}": {
"get": {
"tags": [
"/advertisers/agreementterms"
],
"summary": "Get all agreement terms that a publisher agreed to",
"description": "Returns a set of agreement terms that a publisher agreed to",
"operationId": "getPublisherAdvertiserAgreement",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/publisher_id"
},
{
"$ref": "#/components/parameters/filter_agreement_terms_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agreement_terms_publisher"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/apps/connected": {
"get": {
"tags": [
"/advertisers/apps/connected"
],
"summary": "Get all apps connected",
"description": "Returns a set of apps connected",
"operationId": "getAllAppsConnectedAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_apps_connected_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apps_connected"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/apps/connected/{app_id}": {
"get": {
"tags": [
"/advertisers/apps/connected"
],
"summary": "Get app connected",
"description": "Returns an app connected",
"operationId": "getAppsConnectedAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/app_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apps_connected"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/apps/connected"
],
"summary": "Delete an app connection",
"description": "Deletes an app connection by app ID",
"operationId": "deleteAppsConnected",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/app_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/clearinghouse/suppressionlists": {
"get": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Get all suppression lists",
"description": "Returns a list of suppression lists",
"operationId": "getAllSuppressionListsAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_name"
},
{
"$ref": "#/components/parameters/filter_email_hash"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clearinghouse_suppression_list"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Create a suppression list",
"description": "Creates a suppression list",
"operationId": "addSuppressionListAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_list_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_list"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/clearinghouse/suppressionlists/{list_id}": {
"get": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Get a suppression list",
"description": "Returns a suppression list",
"operationId": "getSuppressionListAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/list_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_list"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/clearinghouse/suppressionlists/{list_id}/programs": {
"get": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Get programs linked to suppression list",
"description": "Returns linked programs",
"operationId": "getSuppressionListProgramsAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/list_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_list_programs"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Link suppression list to program",
"description": "Returns a suppression list",
"operationId": "addSuppressionListProgramsAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/list_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_list_program_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_list_programs"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/clearinghouse/suppressionlists/{list_id}/emails": {
"get": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Get all emails in suppression lists",
"description": "Returns a list of emails in the suppression lists",
"operationId": "getAllSuppressionListEmailAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/list_id"
},
{
"$ref": "#/components/parameters/filter_email_hash"
},
{
"$ref": "#/components/parameters/filter_startdate_start"
},
{
"$ref": "#/components/parameters/filter_startdate_end"
},
{
"$ref": "#/components/parameters/filter_enddate_start"
},
{
"$ref": "#/components/parameters/filter_enddate_end"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clearinghouse_suppression_email"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Add an email to a suppression list",
"description": "Returns an email",
"operationId": "addSuppressionListEmailAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/list_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_email"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_email"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/clearinghouse/suppressionlists/{list_id}/emails/{hash}": {
"get": {
"tags": [
"/advertisers/clearinghouse"
],
"summary": "Get an email from the suppression list",
"description": "Returns an email",
"operationId": "getSuppressionListEmailAdvertiserClearingHouse",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/list_id"
},
{
"$ref": "#/components/parameters/email_hash"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clearinghouse_suppression_email"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/consumer/descriptions": {
"get": {
"tags": [
"/advertisers/consumers/descriptions"
],
"summary": "Get program consumer descriptions",
"description": "Returns program descriptions for consumers",
"operationId": "getAllDescriptionsAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_description_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_language_code"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_consumer_description"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/consumers/descriptions"
],
"summary": "Add program consumer description",
"description": "Add a consumer description for a program",
"operationId": "addDescriptionAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_description_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_description"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/consumer/descriptions/{description_id}": {
"get": {
"tags": [
"/advertisers/consumers/descriptions"
],
"summary": "Get program consumer description",
"description": "Returns a program consumer description by description id",
"operationId": "getDescriptionAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/description_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_description"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/consumers/descriptions"
],
"summary": "Update program consumer description",
"description": "Update a program consumer description. Only one description is allowed per program in eachlanguage.",
"operationId": "updateDescriptionAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/description_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_description_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_description"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/consumer/delivery": {
"get": {
"tags": [
"/advertisers/consumers/delivery"
],
"summary": "Get program consumer delivery info",
"description": "Returns information for consumers about delivery costs and delivery time, for each program andcountry",
"operationId": "getAllDeliveryAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_delivery_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_country_code"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_consumer_delivery"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/consumers/delivery"
],
"summary": "Add program consumer delivery information",
"description": "Add program consumer delivery information. Only one record is allowed for each program in eachcountry.",
"operationId": "addDeliveryAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_delivery_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_delivery"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/consumer/delivery/{delivery_id}": {
"get": {
"tags": [
"/advertisers/consumers/delivery"
],
"summary": "Get program consumer delivery information",
"description": "Returns information for consumers about delivery costs and delivery time, for one program andcountry",
"operationId": "getDeliveryAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/delivery_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_delivery"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/consumers/delivery"
],
"summary": "Update program consumer delivery information",
"description": "Update program consumer delivery information. Only one record is allowed for each program ineach country.",
"operationId": "updateDeliveryAdvertiserConsumer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/delivery_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_delivery_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_consumer_delivery"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/contract": {
"get": {
"tags": [
"/advertisers/programs/contract"
],
"summary": "Get contract via pandadoc",
"description": "Get contract",
"operationId": "getContract",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contract_get"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/programs/contract"
],
"summary": "Send contract via pandadoc",
"description": "Send contract",
"operationId": "sendContract",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contract_send"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/contract/attachment": {
"get": {
"tags": [
"/advertisers/programs/contract"
],
"summary": "Download a contract",
"description": "Download a contract through the pandadoc service",
"operationId": "downloadContract",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/financial/invoices": {
"get": {
"tags": [
"/advertisers/financial/invoices"
],
"summary": "Get invoices",
"description": "Returns invoices",
"operationId": "getAllInvoicesAdvertiserFinancial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/advertiser_invoice_number"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_status"
},
{
"$ref": "#/components/parameters/order_by_invoice"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_financial_invoice"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/google/permissions": {
"get": {
"tags": [
"/advertisers/google/permissions"
],
"summary": "Get google permissions",
"description": "Get google permissions",
"operationId": "getAllAdvertiserGoogle",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_google_account"
},
{
"$ref": "#/components/parameters/filter_google_service"
},
{
"$ref": "#/components/parameters/filter_google_permission"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/google_permission"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/google/permissions"
],
"summary": "Add google permission",
"description": "Add google permission. After successful add, authorize.",
"operationId": "addAdvertiserGoogle",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/google_permission_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/google_permission"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/google/permissions/{google_permission_id}": {
"get": {
"tags": [
"/advertisers/google/permissions"
],
"summary": "Get google permission by id",
"description": "Get google permission by id",
"operationId": "getAdvertiserGoogle",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/google_permission_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/google_permission"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/google/permissions"
],
"summary": "Update a google permission",
"description": "Update a google permission",
"operationId": "updateAdvertiserGoogle",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/google_permission_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/google_permission_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/google_permission"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/google/permissions"
],
"summary": "Delete permission by id",
"description": "Deletes a permission",
"operationId": "deleteAdvertiserGoogle",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/google_permission_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/google/permissions/{google_permission_id}/authorize": {
"post": {
"tags": [
"/advertisers/google/permissions"
],
"summary": "Authorize a Google Service",
"description": "Authorize a Google service",
"operationId": "authorizeAdvertiserGoogle",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/google_permission_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/google_auth_callback"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/google_permission"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/interfacesettings": {
"get": {
"tags": [
"/advertisers/interfacesettings"
],
"summary": "Get all interfacesettings",
"description": "Returns a set of interfacesettings",
"operationId": "getAllAdvertiserInterfacesettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_name"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/interface_settings"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/interfacesettings"
],
"summary": "Add interfacesettings",
"description": "Adds interfacesettings",
"operationId": "addAdvertiserInterfacesetting",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/interface_settings"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/interface_settings"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"409": {
"$ref": "#/components/responses/409"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/interfacesettings/{name}": {
"get": {
"tags": [
"/advertisers/interfacesettings"
],
"summary": "Get interfacesetting by name",
"description": "Returns interfacesetting",
"operationId": "getAdvertiserInterfacesetting",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/name"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/interface_settings"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/interfacesettings"
],
"summary": "Update interfacesettings",
"description": "Updates interfacesettings",
"operationId": "updateAdvertiserInterfacesetting",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/name"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/interface_settings_update"
}
}
}
},
"responses": {
"202": {
"description": "accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/interface_settings"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/interfacesettings"
],
"summary": "Delete interfacesetting by name",
"description": "Deletes interfacesetting",
"operationId": "deleteAdvertiserInterfacesetting",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/name"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/leads": {
"get": {
"tags": [
"/advertisers/leads"
],
"summary": "Get all leads",
"description": "Returns a set of leads
You must provide a start and end date filter OR provide a approval,click or modified (start and/or end) date",
"operationId": "getAllLeadsAdvertiserLead",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_click_date_start"
},
{
"$ref": "#/components/parameters/filter_click_date_end"
},
{
"$ref": "#/components/parameters/filter_approval_date_start"
},
{
"$ref": "#/components/parameters/filter_approval_date_end"
},
{
"$ref": "#/components/parameters/filter_modified_date_start"
},
{
"$ref": "#/components/parameters/filter_modified_date_end"
},
{
"$ref": "#/components/parameters/filter_affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_lead_id"
},
{
"$ref": "#/components/parameters/filter_lead_description"
},
{
"$ref": "#/components/parameters/filter_lead_status"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lead"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/leads/{affiliatemarketing_id}": {
"get": {
"tags": [
"/advertisers/leads"
],
"summary": "Get lead",
"description": "Returns a lead",
"operationId": "getLeadAdvertiserLead",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lead"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/leaddata": {
"get": {
"tags": [
"/advertisers/leaddata"
],
"summary": "Get all lead data",
"description": "Returns a set of leads
You must provide a start and end date filter",
"operationId": "getAllAdvertiserLeadData",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_date_out_start"
},
{
"$ref": "#/components/parameters/filter_date_out_end"
},
{
"$ref": "#/components/parameters/filter_affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lead_v2"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/leaddata/{affiliatemarketing_id}": {
"get": {
"tags": [
"/advertisers/leaddata"
],
"summary": "Get lead",
"description": "Returns a lead",
"operationId": "getAdvertiserLeadData",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lead_v2"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/mailingapproval": {
"get": {
"tags": [
"/advertisers/mailings"
],
"summary": "Get all mailing approval requests",
"description": "Returns a set of mailing approval requests",
"operationId": "getAllMailingApprovalRequestsAdvertiserMailingApproval",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_mailing_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_mailing_approval_type"
},
{
"$ref": "#/components/parameters/filter_mailing_approval_url"
},
{
"$ref": "#/components/parameters/filter_sender_name"
},
{
"$ref": "#/components/parameters/filter_sender"
},
{
"$ref": "#/components/parameters/filter_subject"
},
{
"$ref": "#/components/parameters/filter_send_date_start"
},
{
"$ref": "#/components/parameters/filter_send_date_end"
},
{
"$ref": "#/components/parameters/filter_approval_request_date_start"
},
{
"$ref": "#/components/parameters/filter_approval_request_date_end"
},
{
"$ref": "#/components/parameters/filter_description"
},
{
"$ref": "#/components/parameters/filter_emails"
},
{
"$ref": "#/components/parameters/filter_note"
},
{
"$ref": "#/components/parameters/filter_mailing_status"
},
{
"$ref": "#/components/parameters/order_by_mailingapproval"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mailing_approval_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/mailingapproval/{mailing_id}": {
"get": {
"tags": [
"/advertisers/mailings"
],
"summary": "Get a mailing approval request",
"description": "Returns a mailing approval request",
"operationId": "getMailingApprovalRequestAdvertiserMailingApproval",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/mailing_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mailing_approval_advertiser"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/mailings"
],
"summary": "Update mailing approval request",
"description": "",
"operationId": "updateMailingApprovalRequestAdvertiserMailingApproval",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/mailing_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/mailing_approval_update_advertiser"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/mailing_approval_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
},
"422": {
"$ref": "#/components/responses/422"
},
"500": {
"$ref": "#/components/responses/500"
},
"502": {
"$ref": "#/components/responses/502"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/mailingapproval/{mailing_id}/preview": {
"get": {
"tags": [
"/advertisers/mailings"
],
"summary": "Get a mailing preview",
"description": "Returns a mailing preview, returns the image in case of a screenshot, html otherwise",
"operationId": "getAdvertiserMailingApprovalPreview",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/mailing_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
},
"500": {
"$ref": "#/components/responses/500"
},
"502": {
"$ref": "#/components/responses/502"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups": {
"get": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Get all ad groups",
"description": "Returns a set of ad groups",
"operationId": "getAllAdGroupsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_ad_group_id"
},
{
"$ref": "#/components/parameters/filter_ad_group_status"
},
{
"$ref": "#/components/parameters/filter_start_date"
},
{
"$ref": "#/components/parameters/filter_end_date"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_material_ad_type"
},
{
"$ref": "#/components/parameters/filter_locale_id"
},
{
"$ref": "#/components/parameters/filter_media_group_id"
},
{
"$ref": "#/components/parameters/filter_by_annual_event_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ad_group_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Create an ad group",
"description": "Create an ad group",
"operationId": "addAdGroupAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_group_advertiser_create"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_group_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}": {
"get": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Get ad group",
"description": "Returns an ad group",
"operationId": "getAdGroupAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_group_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Update ad group",
"description": "Update an ad group",
"operationId": "updateAdGroupAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_group_advertiser_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_group_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Delete ad group by id",
"description": "Delete ad group by id",
"operationId": "deleteAdGroupAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads": {
"get": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Get all ad group ads",
"description": "Returns a set of ads",
"operationId": "getAllAdGroupAdsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_type"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_modified_date_start"
},
{
"$ref": "#/components/parameters/filter_modified_date_end"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/image": {
"post": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Create an image ad",
"description": "Create an image ad",
"operationId": "saveAdImageAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_image"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/remote": {
"post": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Create a remote ad",
"description": "Create a remote ad",
"operationId": "saveAdRemoteAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_remote"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/text": {
"post": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Create a text ad",
"description": "Create a text ad",
"operationId": "saveAdTextAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_text"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/html": {
"post": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Create an html ad",
"description": "Create an html ad",
"operationId": "saveAdHtmlAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_html"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/image/{ad_id}": {
"put": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Update an image ad",
"description": "Update an image ad",
"operationId": "updateAdImageAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_image_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/remote/{ad_id}": {
"put": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Update a remote ad",
"description": "Update a remote ad",
"operationId": "updateAdRemoteAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_remote_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/text/{ad_id}": {
"put": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Update a text ad",
"description": "Update a text ad",
"operationId": "updateAdTextAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_text_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/html/{ad_id}": {
"put": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Update an html ad",
"description": "Update an html ad",
"operationId": "updateAdHtmlAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_html"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/{ad_id}": {
"get": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Get an ad group ad",
"description": "Returns an ad",
"operationId": "getAdAdGroupAdsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Delete an ad by id",
"description": "Delete an ad by id",
"operationId": "deleteAdAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ads": {
"get": {
"tags": [
"/advertisers/material/ads"
],
"summary": "Get all ads",
"description": "Returns a set of ads",
"operationId": "getAllAdsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_ad_type"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_modified_date_start"
},
{
"$ref": "#/components/parameters/filter_modified_date_end"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ads/{ad_id}": {
"get": {
"tags": [
"/advertisers/material/ads"
],
"summary": "Get ad",
"description": "Returns an ad",
"operationId": "getAdAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ad_advertiser"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/{ad_id}/attachments": {
"get": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Get an ad group ad attachments",
"description": "Returns an ad attachments",
"operationId": "getAdAdGroupAdsAdvertiserMaterilAattachments",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ad_attachment"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/{ad_group_id}/ads/{ad_id}/attachments/{filename}": {
"get": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Download ad group ad attachment",
"description": "Download an ad attachment",
"operationId": "downloadAdAttachments",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ad_group_id"
},
{
"$ref": "#/components/parameters/ad_id"
},
{
"$ref": "#/components/parameters/filename"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/promotions": {
"get": {
"tags": [
"/advertisers/material/promotions"
],
"summary": "Get all promotions",
"description": "Returns a set of promotions",
"operationId": "getAllPromotionsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_promotion_status"
},
{
"$ref": "#/components/parameters/filter_promotion_has_code"
},
{
"$ref": "#/components/parameters/filter_promotion_code"
},
{
"$ref": "#/components/parameters/filter_promotion_type"
},
{
"$ref": "#/components/parameters/filter_locale_id"
},
{
"$ref": "#/components/parameters/filter_promotion_available_for"
},
{
"$ref": "#/components/parameters/filter_promotion_available_for_media_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_currency_code"
},
{
"$ref": "#/components/parameters/filter_by_annual_event_id"
},
{
"$ref": "#/components/parameters/order_by_promotion"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/promotion_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/material/promotions"
],
"summary": "Add promotions",
"description": "Add promotions",
"operationId": "addPromotionsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/promotion_advertiser_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/promotion_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/promotions/{promotion_id}": {
"get": {
"tags": [
"/advertisers/material/promotions"
],
"summary": "Get promotion",
"description": "Returns a promotion",
"operationId": "getPromotionAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/promotion_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/promotion_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/material/promotions"
],
"summary": "Update a promotion",
"description": "Update a promotion",
"operationId": "updatePromotionAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/promotion_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/promotion_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/promotion_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/material/promotions"
],
"summary": "Delete promotion",
"description": "Delete promotion",
"operationId": "deletePromotionAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/promotion_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/ad-groups/summary": {
"get": {
"tags": [
"/advertisers/material/ad-groups"
],
"summary": "Get ad groups summary",
"description": "Returns total ad counts of ad groups",
"operationId": "getSummaryAdGroupsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_ad_group_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ad_group_summary"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/deeplinks": {
"get": {
"tags": [
"/advertisers/material/deeplinks"
],
"summary": "Get all ads with type deeplink",
"description": "Returns a set of ads with type deeplink",
"operationId": "getAllDeeplinkAdsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/order_by_deeplink"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_ad_with_deeplink"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/material/deeplinks"
],
"summary": "Create an ad with type deeplink",
"description": "Create an ad with type deeplink",
"operationId": "addDeeplinkAd",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_ad_with_deeplink_body"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_ad_with_deeplink"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/material/deeplinks/{deeplink_id}": {
"get": {
"tags": [
"/advertisers/material/deeplinks"
],
"summary": "Get an ad with type deeplink",
"description": "Returns an ad with type deeplink",
"operationId": "getDeeplinkAdsAdvertiserMaterial",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/deeplink_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_ad_with_deeplink"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/material/deeplinks"
],
"summary": "Update an ad with type deeplink",
"description": "Update ad with type deeplink",
"operationId": "updateDeeplinkAd",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/deeplink_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_ad_with_deeplink_body"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_ad_with_deeplink"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/material/deeplinks"
],
"summary": "Delete ad deeplink by id",
"description": "Delete ad deeplink by id",
"operationId": "deleteDeeplinkAd",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/deeplink_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media": {
"get": {
"tags": [
"/advertisers/media"
],
"summary": "Get all media",
"description": "Returns a set of all media",
"operationId": "getAllAdvertiserMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_search_term_no_wildcard"
},
{
"$ref": "#/components/parameters/filter_keywords"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_country_id"
},
{
"$ref": "#/components/parameters/filter_language_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_group_id"
},
{
"$ref": "#/components/parameters/filter_advertiser_media_subscription_status"
},
{
"$ref": "#/components/parameters/filter_subscribe_date"
},
{
"$ref": "#/components/parameters/filter_subscribe_approval_date"
},
{
"$ref": "#/components/parameters/order_by_advertiser_media"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}": {
"get": {
"tags": [
"/advertisers/media"
],
"summary": "Get media by id",
"description": "Returns a media",
"operationId": "getAdvertiserMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/summary": {
"get": {
"tags": [
"/advertisers/media"
],
"summary": "Get media summary",
"description": "Returns a media summary",
"operationId": "getSummaryAdvertiserMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_search_term_no_wildcard"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_country_id"
},
{
"$ref": "#/components/parameters/filter_language_id"
},
{
"$ref": "#/components/parameters/filter_advertiser_media_subscription_status"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_advertiser_summary"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/commissions": {
"get": {
"tags": [
"/advertisers/media"
],
"summary": "Get program commissions",
"description": "Returns a set of program commissions for a specific media",
"operationId": "getCommissionsAdvertiserMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/compensation"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/keywords": {
"get": {
"tags": [
"/advertisers/media"
],
"summary": "Get keyword suggestions",
"description": "Returns keyword suggestions for media",
"operationId": "getKeywordsAdvertiserMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_keywords"
},
{
"$ref": "#/components/parameters/filter_language_code_required"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_advertiser_keywords"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/similar-media": {
"get": {
"tags": [
"/advertisers/media"
],
"summary": "Get similar media by media id",
"description": "Returns list of media. By default this will return not subscribed media",
"operationId": "getSimilarMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/filter_advertiser_media_subscription_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/recommended": {
"get": {
"tags": [
"/advertisers/media"
],
"summary": "Get all recommended media",
"description": "Returns a set of recommended media",
"operationId": "getRecommended",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recommended_media_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all media groups",
"description": "Returns a set of media groups",
"operationId": "getAllAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_media_group_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Add a new media group",
"description": "Add a new media group",
"operationId": "addAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get media group by id",
"description": "Returns a media group",
"operationId": "getAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_advertiser"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Update a media group",
"description": "Update a media group",
"operationId": "updateAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Delete a media group",
"description": "Delete a media group",
"operationId": "deleteMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/news": {
"get": {
"tags": [
"/advertisers/news"
],
"summary": "Get all news items",
"description": "Returns a set of news items",
"operationId": "getAllNewsItemsAdvertiserNews",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_news_id"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_locale_id"
},
{
"$ref": "#/components/parameters/filter_news_type_advertiser"
},
{
"$ref": "#/components/parameters/filter_title"
},
{
"$ref": "#/components/parameters/filter_text"
},
{
"$ref": "#/components/parameters/filter_newsletter"
},
{
"$ref": "#/components/parameters/filter_news_subscribed"
},
{
"$ref": "#/components/parameters/filter_news_status"
},
{
"$ref": "#/components/parameters/filter_news_search"
},
{
"$ref": "#/components/parameters/order_by_news"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/news_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/news"
],
"summary": "Create a news item",
"description": "Create a new news item",
"operationId": "addNewsItemAdvertiserNews",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/news_mutable_advertiser"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/news"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/news/{news_id}": {
"get": {
"tags": [
"/advertisers/news"
],
"summary": "Get a news item",
"description": "Returns a news item",
"operationId": "getNewsItemAdvertiserNews",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/news_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/news_advertiser"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/news"
],
"summary": "Update a news item",
"description": "Update a news item",
"operationId": "updateNewsItemAdvertiserNews",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/news_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/news_mutable_advertiser"
}
}
}
},
"responses": {
"201": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/news"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/notifications": {
"get": {
"tags": [
"/advertisers/notifications"
],
"summary": "Get all notifications",
"description": "Returns an array of notifications",
"operationId": "getAllNotificationsAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_notification_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_language_ids"
},
{
"$ref": "#/components/parameters/filter_notification_recipient"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_notification_status_advertiser"
},
{
"$ref": "#/components/parameters/filter_send_datetime_start"
},
{
"$ref": "#/components/parameters/filter_send_datetime_end"
},
{
"$ref": "#/components/parameters/order_by_notification"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/notifications"
],
"summary": "Create a new notification",
"description": "Create a new notification",
"operationId": "addNotificationAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_advertiser_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/notifications/{notification_id}": {
"get": {
"tags": [
"/advertisers/notifications"
],
"summary": "Get a notification",
"description": "Returns a single notification",
"operationId": "getNotificationAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/notifications"
],
"summary": "Update an unsent notification",
"description": "Update an unsent notification",
"operationId": "updateNotificationAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_advertiser_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/notifications"
],
"summary": "Delete an unsent notification",
"description": "Delete an unsent notification",
"operationId": "deleteNotificationAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/notifications/receive": {
"get": {
"tags": [
"/advertisers/notifications/receive"
],
"summary": "Get all received notifications",
"description": "Get all received notifications",
"operationId": "getAllAdvertiserNotificationReceive",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_notification_id"
},
{
"$ref": "#/components/parameters/filter_language_ids"
},
{
"$ref": "#/components/parameters/filter_notification_level"
},
{
"$ref": "#/components/parameters/filter_advertiser_notification_source"
},
{
"$ref": "#/components/parameters/filter_notification_status_advertiser_receive"
},
{
"$ref": "#/components/parameters/filter_notification_date_start"
},
{
"$ref": "#/components/parameters/filter_notification_date_end"
},
{
"$ref": "#/components/parameters/order_by_notification"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_receive_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/notifications/receive/{notification_id}": {
"get": {
"tags": [
"/advertisers/notifications/receive"
],
"summary": "Get received notification",
"description": "Get received notification",
"operationId": "getAdvertiserNotificationReceive",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_receive_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/notifications/receive"
],
"summary": "Update a notification as read",
"description": "Update a notification as read",
"operationId": "updateAdvertiserNotificationReceive",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/notifications/receive"
],
"summary": "Delete a received notification",
"description": "Delete a received notification",
"operationId": "deleteAdvertiserNotificationReceive",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/notifications/templates": {
"get": {
"tags": [
"/advertisers/notification/templates"
],
"summary": "Get all notification templates",
"description": "",
"operationId": "getAllTemplatesAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_language_id"
},
{
"$ref": "#/components/parameters/filter_title"
},
{
"$ref": "#/components/parameters/filter_text"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_template"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/notification/templates"
],
"summary": "Create a new notification template",
"description": "",
"operationId": "addTemplateAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_template_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_template"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/notifications/templates/{notification_template_id}": {
"get": {
"tags": [
"/advertisers/notification/templates"
],
"summary": "Get a notification template",
"description": "",
"operationId": "getTemplateByIdAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_template_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_template"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/notification/templates"
],
"summary": "Update a notification template",
"description": "",
"operationId": "updateTemplateAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_template_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_template_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notification_template"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/notification/templates"
],
"summary": "Delete a notification template",
"description": "",
"operationId": "deleteTemplateAdvertiserNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/notification_template_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/paymentinfo": {
"get": {
"tags": [
"/advertisers/payment"
],
"summary": "Get advertisers paymentinfo",
"description": "Returns payment information",
"operationId": "getPaymentinfoAdvertiserAccount",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_paymentinfo"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/payment"
],
"summary": "Update advertiser payment info",
"description": "Update advertiser payment info",
"operationId": "putPaymentInfoAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_paymentinfo_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_paymentinfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/payment"
],
"summary": "Add advertiser payment info",
"description": "Add advertiser payment info. Country ID is required.",
"operationId": "postPaymentInfoAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_paymentinfo_create"
}
}
}
},
"responses": {
"201": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_paymentinfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/paymentinfo/history": {
"get": {
"tags": [
"/advertisers/payment"
],
"summary": "Get advertisers payment info history",
"description": "Returns payment info history",
"operationId": "getPaymentInfoHistoryAdvertiserAccount",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_payment_info_history"
}
}
}
},
"204": {
"description": "no content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/paymentinfo/history/{history_id}": {
"get": {
"tags": [
"/advertisers/payment"
],
"summary": "Get advertiser payment info history by id",
"description": "Returns payment info history",
"operationId": "getPaymentInfoHistoryByIdAdvertiserAccount",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/history_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_payment_info_history"
}
}
}
},
"404": {
"description": "not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/phonenumbers": {
"get": {
"tags": [
"/advertisers/phonenumbers"
],
"summary": "Get advertiser phonenumbers",
"description": "Returns phonenumbers",
"operationId": "getPhonenumbersAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/phonenumber_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/phonenumbers"
],
"summary": "Add advertiser phone number",
"description": "Add advertiser phone number. Country ID is required.",
"operationId": "postPhoneNumberAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/phonenumber_advertiser_update"
}
}
}
},
"responses": {
"201": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/phonenumber_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/phonenumbers/{phonenumber_id}": {
"get": {
"tags": [
"/advertisers/phonenumbers"
],
"summary": "Get advertiser phone number",
"description": "Returns advertiser phone number",
"operationId": "getPhoneNumberAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/phonenumber_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/phonenumber_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/phonenumbers"
],
"summary": "Update advertiser phone number",
"description": "Update advertiser phone number",
"operationId": "putPhoneNumberAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/phonenumber_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/phonenumber_advertiser_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/phonenumber_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/phonenumbers"
],
"summary": "Delete advertiser phone number",
"description": "Delete advertiser phone number",
"operationId": "deletePhoneNumberAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/phonenumber_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/productfeeds": {
"get": {
"tags": [
"/advertisers/productfeeds"
],
"summary": "Get all productfeeds",
"description": "Returns a set of productfeeds",
"operationId": "getAllAdvertiserProductfeeds",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_standard_id"
},
{
"$ref": "#/components/parameters/filter_language_code"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"deprecated": true,
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/productfeeds/{productfeed_id}": {
"get": {
"tags": [
"/advertisers/productfeeds"
],
"summary": "Get productfeed by id",
"description": "Returns a productfeed",
"operationId": "getAdvertiserProductfeeds",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/productfeed_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"deprecated": true,
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/productfeeds/{productfeed_id}/mapping": {
"get": {
"tags": [
"/advertisers/productfeeds"
],
"summary": "Get productfeed mapping by productfeed_id",
"description": "Returns the mapping of a productfeed",
"operationId": "getMappingAdvertiserProductfeeds",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/productfeed_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser_mapping"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/productfeeds/{productfeed_id}/mutations": {
"get": {
"tags": [
"/advertisers/productfeeds"
],
"summary": "Get productfeed mutations by productfeed_id",
"description": "Returns the mutations of a productfeed",
"operationId": "getMutationsAdvertiserProductfeeds",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/productfeed_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser_mutations"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/productfeeds/{productfeed_id}/filters": {
"get": {
"tags": [
"/advertisers/productfeeds"
],
"summary": "Get productfeed filters by productfeed_id",
"description": "Returns the filters of a productfeed",
"operationId": "getFiltersAdvertiserProductfeeds",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/productfeed_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser_filters"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/productfeeds/feed": {
"get": {
"tags": [
"/advertisers/productfeeds"
],
"summary": "Get productfeed serving details",
"description": "Returns a productfeed as served to a publisher",
"operationId": "getFeedAdvertiserProductfeeds",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id_required"
},
{
"$ref": "#/components/parameters/filter_standard_id_required"
},
{
"$ref": "#/components/parameters/filter_language_code_required"
},
{
"$ref": "#/components/parameters/filter_dedicated_media_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser_feed"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs": {
"get": {
"tags": [
"/advertisers/programs"
],
"summary": "Get all programs",
"description": "Returns a set of programs",
"operationId": "getAllProgramsAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_name"
},
{
"$ref": "#/components/parameters/filter_currency_code"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_locale_id"
},
{
"$ref": "#/components/parameters/filter_supply_locale_id"
},
{
"$ref": "#/components/parameters/filter_program_productfeed"
},
{
"$ref": "#/components/parameters/filter_program_deeplink"
},
{
"$ref": "#/components/parameters/filter_program_publisher_tag"
},
{
"$ref": "#/components/parameters/filter_advertiser_program_status"
},
{
"$ref": "#/components/parameters/filter_allowed_media_type_id"
},
{
"$ref": "#/components/parameters/placeholder_url_media_id"
},
{
"$ref": "#/components/parameters/placeholder_url_subid"
},
{
"$ref": "#/components/parameters/placeholder_url_subid_2"
},
{
"$ref": "#/components/parameters/placeholder_url_subid_3"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/programs"
],
"summary": "Create a new program",
"description": "Create a new program",
"operationId": "createAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_create"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}": {
"get": {
"tags": [
"/advertisers/programs"
],
"summary": "Get program",
"description": "Returns a program",
"operationId": "getProgramAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/placeholder_url_media_id"
},
{
"$ref": "#/components/parameters/placeholder_url_subid"
},
{
"$ref": "#/components/parameters/placeholder_url_subid_2"
},
{
"$ref": "#/components/parameters/placeholder_url_subid_3"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/programs"
],
"summary": "Update a program",
"description": "Update a program",
"operationId": "updateProgramAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get program tracking settings",
"description": "Returns tracking settings of a program",
"operationId": "getProgramAdvertiserProgramTrackingSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_tracking_settings"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Update program tracking segment id",
"description": "Update program tracking segment id",
"operationId": "updateProgramTrackingSegmentId",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_tracking_segment_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/referrer/settings": {
"get": {
"tags": [
"/advertisers/programs/referrer"
],
"summary": "Get referrer params settings",
"description": "Get referrer params settings",
"operationId": "getProgramAdvertiserReferrerParamsSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_settings"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/programs/referrer"
],
"summary": "Update advertiser program referrer params settings",
"description": "Update advertiser program referrer params settings",
"operationId": "updateProgramAdvertiserReferrerParamsSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_settings_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_settings"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/referrer/params": {
"get": {
"tags": [
"/advertisers/programs/referrer"
],
"summary": "Get all referrer params",
"description": "Get all referrer params",
"operationId": "getProgramAdvertiserReferrerParams",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/order_by_referrer_param"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_referrer_param"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/programs/referrer"
],
"summary": "Save advertiser program referrer params",
"description": "Save advertiser program referrer params",
"operationId": "saveProgramAdvertiserReferrerParams",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_param_create"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_param"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/referrer/params/{param_id}": {
"get": {
"tags": [
"/advertisers/programs/referrer"
],
"summary": "Get referrer params by id",
"description": "Get referrer params by id",
"operationId": "getProgramAdvertiserReferrerParamsById",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/referrer_param_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_param"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/programs/referrer"
],
"summary": "Update advertiser program referrer params",
"description": "Update advertiser program referrer params",
"operationId": "updateProgramAdvertiserReferrerParamsById",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/referrer_param_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_param_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_referrer_param"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/programs/referrer"
],
"summary": "Delete referrer params",
"description": "Delete referrer params",
"operationId": "deleteProgramAdvertiserReferrerParams",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/referrer_param_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/publishers": {
"get": {
"tags": [
"/advertisers/publishers"
],
"summary": "Get all active publishers",
"description": "Returns a set of active publishers",
"operationId": "getAllPublishersAdvertiserPublisher",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_publisher_account_name"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/publisher"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/publishers/{publisher_id}": {
"get": {
"tags": [
"/advertisers/publishers"
],
"summary": "Get an active publisher by id",
"description": "Returns an active publisher",
"operationId": "getPublishersAdvertiserPublisher",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/publisher_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/publisher"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/publishers/{publisher_id}/users": {
"get": {
"tags": [
"/advertisers/publishers"
],
"summary": "Get all active publisher users",
"description": "Returns a set of active publisher users",
"operationId": "getUsersAdvertiserPublisher",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/publisher_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_publisher_user"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/publishers/details": {
"get": {
"tags": [
"/advertisers/publishers/details"
],
"summary": "Get all publisher details",
"description": "Returns a set of publisher details",
"operationId": "getAllAdvertiserPublisherDetails",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_name"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/publisher_detail"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/publishers/{publisher_id}/details": {
"get": {
"tags": [
"/advertisers/publishers/details"
],
"summary": "Get publisher details",
"description": "Returns publisher details",
"operationId": "getAdvertiserPublisherDetails",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/publisher_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/publisher_detail"
}
}
}
}
},
"404": {
"description": "not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/publisherdocuments": {
"get": {
"tags": [
"/advertisers/publisherdocuments"
],
"summary": "Get all publisher documents",
"description": "Returns a set of publisher documents",
"operationId": "getAllPublisherDocumentsAdvertiserPublisherDocument",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_name"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/publisher_document"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/publisherdocuments/{publisher_document_id}": {
"get": {
"tags": [
"/advertisers/publisherdocuments"
],
"summary": "Get publisher document",
"description": "Returns a publisher document",
"operationId": "getPublisherDocumentsAdvertiserPublisherDocument",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/publisher_document_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/publisher_document"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/questionnaires": {
"get": {
"tags": [
"/advertisers/media/questionnaires"
],
"summary": "Get all questionnaires by media",
"description": "Returns all questionnaires by media",
"operationId": "getMediaAdvertiserQuestionnaires",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_questionnaire_media"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/questionnaires/{questionnaire_id}": {
"get": {
"tags": [
"/advertisers/media/questionnaires"
],
"summary": "Get questionnaire by media",
"description": "Returns questionnaires by media",
"operationId": "getMediaAdvertiserQuestionnaire",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/questionnaire_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_questionnaire_media"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/questionnaires/{questionnaire_id}/questions": {
"get": {
"tags": [
"/advertisers/media/questionnaires"
],
"summary": "Get a questionnaire question by media id and question id",
"description": "Returns all media anwered questionnaire questions",
"operationId": "getQuestionsAdvertiserMediaQuestionnaire",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/questionnaire_id"
},
{
"$ref": "#/components/parameters/question_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_questionnaire_media_question"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/questionnaires/{questionnaire_id}/questions/{question_id}": {
"get": {
"tags": [
"/advertisers/media/questionnaires"
],
"summary": "Get a questionnaire question by media id, questionnaire id and question id",
"description": "Returns a question",
"operationId": "getQuestionAdvertiserMediaQuestionnaire",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/questionnaire_id"
},
{
"$ref": "#/components/parameters/question_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_questionnaire_media_question"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/revshare/members": {
"get": {
"tags": [
"/advertisers/revshare"
],
"summary": "Get all members",
"description": "Get all revenue share members",
"operationId": "getMembersAdvertiserRevenueShare",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_reference"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_click_date_start"
},
{
"$ref": "#/components/parameters/filter_click_date_end"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/order_by_advertiser_revenue_share_member"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_revenue_share_member"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/revshare/revshares": {
"get": {
"tags": [
"/advertisers/revshare"
],
"summary": "Get all revenue shares",
"description": "Get all revenue shares",
"operationId": "getRevenueSharesAdvertiserRevenueShare",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_date_start_required"
},
{
"$ref": "#/components/parameters/filter_date_end_required"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_reference"
},
{
"$ref": "#/components/parameters/filter_affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_currency_code"
},
{
"$ref": "#/components/parameters/order_by_advertiser_revenue_share"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_revenue_share"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/assist": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get assist",
"description": "Returns media assist numbers",
"operationId": "getAssistAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_engagement"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions": {
"get": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Get all subscriptions",
"description": "Returns a set of subscriptions",
"operationId": "getAllAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_advertiser_subscription_status"
},
{
"$ref": "#/components/parameters/filter_advertiser_media_subscription_auto_approval_date"
},
{
"$ref": "#/components/parameters/filter_subscription_approval_date_start"
},
{
"$ref": "#/components/parameters/filter_subscription_approval_date_end"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/parameter_media_status"
},
{
"$ref": "#/components/parameters/parameter_publisher_status"
},
{
"$ref": "#/components/parameters/order_by_advertiser_subscription"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/media/{media_id}/hide": {
"put": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Hide a media",
"description": "Hide a media",
"operationId": "hideAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_advertiser_hide"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/media/{media_id}/unhide": {
"put": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Reveal a media",
"description": "Reveal a media",
"operationId": "unhideAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/postpone": {
"put": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Postpone subscription",
"description": "Postpone subscription",
"operationId": "postponeAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_advertiser_postpone"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/media/{media_id}/postpone": {
"put": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Postpone subscription",
"description": "Postpone subscription for a media",
"operationId": "postponeAdvertiserSubscriptionMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subscription_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tickets": {
"get": {
"tags": [
"/advertisers/tickets"
],
"summary": "Get all tickets",
"description": "Returns a set of tickets",
"operationId": "getTicketsAdvertiserSupport",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_ticket_status"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ticket"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"503": {
"$ref": "#/components/responses/503"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tickets/{ticket_id}": {
"get": {
"tags": [
"/advertisers/tickets"
],
"summary": "Get ticket",
"description": "Returns a ticket",
"operationId": "getTicketAdvertiserSupport",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ticket_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ticket_detail"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tickets/{ticket_id}/reply": {
"post": {
"tags": [
"/advertisers/tickets"
],
"summary": "Reply to a ticket",
"description": "",
"operationId": "replyTicketAdvertiserSupport",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ticket_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ticket_reply"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ticket_reply"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"503": {
"$ref": "#/components/responses/503"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tickets/attachment": {
"post": {
"tags": [
"/advertisers/tickets"
],
"summary": "Add a new attachment",
"description": "",
"operationId": "createAttachmentAdvertiserSupport",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"attachment": {
"description": "Zendesk ticket attachment",
"type": "string",
"format": "binary"
},
"upload_token": {
"description": "Optional token additional upload",
"type": "string",
"default": ""
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ticket_attachment_token"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/system-notifications/receive": {
"get": {
"tags": [
"/advertisers/system-notifications/receive"
],
"summary": "Receive system-notifications",
"description": "Returns a set of system-notifications",
"operationId": "receiveAdvertisersSystemNotification",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/system_notification_receive"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/batchprocessing/jobs": {
"get": {
"tags": [
"/advertisers/transactions/batchprocessing/jobs"
],
"summary": "Get all transaction batch jobs",
"description": "Returns a set of batch jobs",
"operationId": "getAllAdvertiserTransactionBatchprocessingJobs",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_transaction_batch_job_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_user_id"
},
{
"$ref": "#/components/parameters/filter_transaction_job_status"
},
{
"$ref": "#/components/parameters/filter_creation_date_start"
},
{
"$ref": "#/components/parameters/filter_creation_date_end"
},
{
"$ref": "#/components/parameters/order_by_advertiser_transaction_batch_job"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_batch_job"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/transactions/batchprocessing/jobs"
],
"summary": "Add a new transaction batchprocessing job",
"description": "Add a batch with transactions in a job",
"operationId": "addJobAdvertisersTransactionBatch",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_batch_job_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_batch_job"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/batchprocessing/jobs/{job_id}": {
"get": {
"tags": [
"/advertisers/transactions/batchprocessing/jobs"
],
"summary": "Get one transaction batch job",
"description": "Returns a transaction batch job",
"operationId": "getJobAdvertiserTransactionBatchprocessingJobs",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/job_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_batch_job"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"patch": {
"tags": [
"/advertisers/transactions/batchprocessing/jobs"
],
"summary": "Mark a transaction batch job as checked",
"description": "Updates the status value of the transaction batch job from 'done' to 'checked",
"operationId": "updateJobAdvertiserTransactionBatchprocessingJobs",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/job_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_batch_job"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/advertisers/{advertiser_id}/transactions/batchprocessing/jobs/{job_id}/results": {
"get": {
"tags": [
"/advertisers/transactions/batchprocessing/jobs"
],
"summary": "Get transaction batch job results per record",
"description": "Returns transaction batch job results per record",
"operationId": "getJobErrorsAdvertiserTransactionBatchprocessingJobs",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/job_id"
},
{
"$ref": "#/components/parameters/filter_transaction_batch_result_success"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_batch_result"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions": {
"get": {
"tags": [
"/advertisers/transactions"
],
"summary": "Get all transactions",
"description": "Returns a set of transactions. You must provide a start and end date filter OR provide aapproval, click or modified (start and/or end) date. If time is omitted, defaults 00:00:00 (for start) and23:59:59 (for end) will be used.",
"operationId": "getAllTransactionsAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_click_date_start"
},
{
"$ref": "#/components/parameters/filter_click_date_end"
},
{
"$ref": "#/components/parameters/filter_approval_date_start"
},
{
"$ref": "#/components/parameters/filter_approval_date_end"
},
{
"$ref": "#/components/parameters/filter_modified_date_start"
},
{
"$ref": "#/components/parameters/filter_modified_date_end"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_disapproved_reason"
},
{
"$ref": "#/components/parameters/filter_transaction_id"
},
{
"$ref": "#/components/parameters/filter_transaction_type_v2"
},
{
"$ref": "#/components/parameters/filter_part_type"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_program_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/filter_advertiser_transaction_invoice_status"
},
{
"$ref": "#/components/parameters/order_by_transaction"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/transactions"
],
"summary": "Add a new transaction",
"description": "",
"operationId": "addTransactionAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/{affiliatemarketing_id}": {
"get": {
"tags": [
"/advertisers/transactions"
],
"summary": "Get transaction",
"description": "Returns a transaction",
"operationId": "getTransactionAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/transactions"
],
"summary": "Update transaction status for all parts",
"description": "",
"operationId": "updateStatusAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser_update"
}
}
}
},
"responses": {
"202": {
"description": "accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/{affiliatemarketing_id}/engagement": {
"get": {
"tags": [
"/advertisers/transactions"
],
"summary": "Get the transaction engagement",
"description": "Get the engagement of a transaction",
"operationId": "getEngagementAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_advertiser_engagement"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/{affiliatemarketing_id}/{part_id}": {
"put": {
"tags": [
"/advertisers/transactions"
],
"summary": "Update transaction part",
"description": "",
"operationId": "updatePartAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/part_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser_part_update"
}
}
}
},
"responses": {
"202": {
"description": "accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/recalculate/{affiliatemarketing_id}/{part_id}": {
"put": {
"tags": [
"/advertisers/transactions"
],
"summary": "Recalculate commission",
"description": "",
"operationId": "updatePartRecalculateAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/part_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser_part_recalculate"
}
}
}
},
"responses": {
"202": {
"description": "accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/approve": {
"put": {
"tags": [
"/advertisers/transactions"
],
"summary": "Approve transactions in bulk",
"description": "Approve transactions in bulk",
"operationId": "approveAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser_bulk_approve"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_advertiser_bulk_assessment"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/disapprove": {
"put": {
"tags": [
"/advertisers/transactions"
],
"summary": "Disapprove transactions in bulk",
"description": "Disapprove transactions in bulk",
"operationId": "disapproveAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_advertiser_bulk_disapprove"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_advertiser_bulk_assessment"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/{affiliatemarketing_id}/{part_id}/history": {
"get": {
"tags": [
"/advertisers/transactions"
],
"summary": "Get transaction part history",
"description": "Get the history of a transaction part",
"operationId": "getPartHistoryAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/part_id"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_advertiser_part_history"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/{affiliatemarketing_id}/attachments": {
"get": {
"tags": [
"/advertisers/transactions/attachments"
],
"summary": "Get all transaction attachments",
"description": "Returns a set of attachments",
"operationId": "getAttachmentsAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_attachment"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/transactions/attachments"
],
"summary": "Add a new transaction attachment",
"description": "",
"operationId": "addAttachmentAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"body": {
"description": "Notes",
"type": "string"
},
"attachment": {
"description": "attachment (max 1MB), files (.jpg, .png, .gif, .pdf)",
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_attachment"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/{affiliatemarketing_id}/attachments/{attachment_id}": {
"get": {
"tags": [
"/advertisers/transactions/attachments"
],
"summary": "Get transaction attachment",
"description": "Returns a transaction attachment",
"operationId": "getAttachmentAdvertiserTransaction",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/attachment_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_attachment"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/transactions/attachments"
],
"summary": "Hard delete an attachment file but retain reference",
"description": "This services will delete an attachment file physically from the drive and update itcorresponding status to deleted.",
"operationId": "deleteTransactionAttachment",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/attachment_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions.v2": {
"get": {
"tags": [
"/advertisers/transactionsv2"
],
"summary": "Get all transactions",
"description": "Returns a set of transactions. You must provide a start and end date filter OR provide aapproval, click or modified (start and/or end) date OR set all_open_transactions to 'true'. If time isomitted, defaults 00:00:00 (for start) and 23:59:59 (for end) will be used.",
"operationId": "getAllAdvertiserTransactionV2",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_currency_codes"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_click_date_start"
},
{
"$ref": "#/components/parameters/filter_click_date_end"
},
{
"$ref": "#/components/parameters/filter_approval_date_start"
},
{
"$ref": "#/components/parameters/filter_approval_date_end"
},
{
"$ref": "#/components/parameters/filter_modified_date_start"
},
{
"$ref": "#/components/parameters/filter_modified_date_end"
},
{
"$ref": "#/components/parameters/filter_all_open_transactions"
},
{
"$ref": "#/components/parameters/filter_affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_transaction_id"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_transaction_type_v2"
},
{
"$ref": "#/components/parameters/filter_part_type"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_disapproved_reason"
},
{
"$ref": "#/components/parameters/filter_ip_hash"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_transaction_commission_start"
},
{
"$ref": "#/components/parameters/filter_transaction_commission_end"
},
{
"$ref": "#/components/parameters/filter_transaction_revenue_start"
},
{
"$ref": "#/components/parameters/filter_transaction_revenue_end"
},
{
"$ref": "#/components/parameters/filter_promotioncode"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/filter_advertiser_transaction_invoice_status"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_ip_country_code"
},
{
"$ref": "#/components/parameters/order_by_advertiser_transaction_v2"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_v2_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions.v2/raw": {
"get": {
"tags": [
"/advertisers/transactionsv2"
],
"summary": "Get all raw transactions",
"description": "Returns a set of raw transaction parts. You must provide a start and end date filter. If timeis omitted, defaults 00:00:00 (for start) and 23:59:59 (for end) will be used.",
"operationId": "getAllRawAdvertiserTransactionV2",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_transaction_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_transaction_raw_fields"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_v2_advertiser_raw"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions.v2/{affiliatemarketing_id}": {
"get": {
"tags": [
"/advertisers/transactionsv2"
],
"summary": "Get transaction",
"description": "Returns a transaction",
"operationId": "getAdvertiserTransactionV2",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_v2_advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions.v2/summary": {
"get": {
"tags": [
"/advertisers/transactionsv2"
],
"summary": "Get transaction summary",
"description": "Returns a transaction summary. You must provide a start and end date filter OR provide aapproval, click or modified (start and/or end) date OR set all_open_transactions to 'true'. If time isomitted, defaults 00:00:00 (for start) and 23:59:59 (for end) will be used.",
"operationId": "getSummaryAdvertiserTransactionV2",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_currency_codes"
},
{
"$ref": "#/components/parameters/filter_date_start"
},
{
"$ref": "#/components/parameters/filter_date_end"
},
{
"$ref": "#/components/parameters/filter_click_date_start"
},
{
"$ref": "#/components/parameters/filter_click_date_end"
},
{
"$ref": "#/components/parameters/filter_approval_date_start"
},
{
"$ref": "#/components/parameters/filter_approval_date_end"
},
{
"$ref": "#/components/parameters/filter_modified_date_start"
},
{
"$ref": "#/components/parameters/filter_modified_date_end"
},
{
"$ref": "#/components/parameters/filter_all_open_transactions"
},
{
"$ref": "#/components/parameters/filter_affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_transaction_id"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_transaction_type_v2"
},
{
"$ref": "#/components/parameters/filter_part_type"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_disapproved_reason"
},
{
"$ref": "#/components/parameters/filter_ip_hash"
},
{
"$ref": "#/components/parameters/filter_ip_country_code"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_transaction_commission_start"
},
{
"$ref": "#/components/parameters/filter_transaction_commission_end"
},
{
"$ref": "#/components/parameters/filter_transaction_revenue_start"
},
{
"$ref": "#/components/parameters/filter_transaction_revenue_end"
},
{
"$ref": "#/components/parameters/filter_promotioncode"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_v2_advertiser_summary"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions.v2/{affiliatemarketing_id}/parts": {
"get": {
"tags": [
"/advertisers/transactionsv2"
],
"summary": "Get all parts of a transaction",
"description": "Returns a set of parts of a transaction",
"operationId": "getAllPartsAdvertiserTransactionV2",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/filter_part_id"
},
{
"$ref": "#/components/parameters/filter_part_type"
},
{
"$ref": "#/components/parameters/filter_part_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_v2_advertiser_part"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions.v2/{affiliatemarketing_id}/parts/{part_id}": {
"get": {
"tags": [
"/advertisers/transactionsv2"
],
"summary": "Get a part of a transaction",
"description": "Returns a part of a transaction",
"operationId": "getPartAdvertiserTransactionV2",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/affiliatemarketing_id"
},
{
"$ref": "#/components/parameters/part_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/transaction_v2_advertiser_part"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/users": {
"get": {
"tags": [
"/advertisers/user"
],
"summary": "Get connected user profiles",
"description": "Returns connected user profiles",
"operationId": "getAllUsersAdvertiserUser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_user_connection_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user_profile_permission"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/user"
],
"summary": "Adds a user to your account",
"description": "Returns a user profile",
"operationId": "addUserAdvertiserUser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user_access_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user_profile"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/users/{user_id}/permissions": {
"get": {
"tags": [
"/advertisers/user"
],
"summary": "Gets all user permissions",
"description": "Returns all user permissions",
"operationId": "getAllUserPermissionsAdvertiserUser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/user_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_permission"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/user"
],
"summary": "Adds permission to a user",
"description": "Adds permission to a user",
"operationId": "addUserPermissionsAdvertiserUser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/user_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user_permission_update"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user_profile"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/users/{user_id}/permissions/{permission}": {
"delete": {
"tags": [
"/advertisers/user"
],
"summary": "Removes a permission from a user",
"description": "",
"operationId": "deleteUserPermissionsAdvertiserUser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/user_id"
},
{
"$ref": "#/components/parameters/permission"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/users/{user_id}": {
"delete": {
"tags": [
"/advertisers/user"
],
"summary": "Removes a permission from a user",
"description": "",
"operationId": "deleteUserAdvertiserUser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/user_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"405": {
"$ref": "#/components/responses/405"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers": {
"get": {
"tags": [
"/advertisers"
],
"summary": "Get all advertisers",
"description": "Returns a set of advertisers",
"operationId": "getAllAdvertisers",
"parameters": [
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers"
],
"summary": "Adds an Advertiser",
"description": "Creates and return information of the newly created advertiser.",
"operationId": "addAdvertiser",
"requestBody": {
"description": "Advertiser data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}": {
"get": {
"tags": [
"/advertisers"
],
"summary": "Get advertiser",
"description": "Returns a advertiser by ID",
"operationId": "getAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/date": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by transaction date",
"description": "Returns statistics grouped by transaction date",
"operationId": "getDateAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_smartview"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_date"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/hour": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by hour",
"description": "Returns statistics grouped by hour",
"operationId": "getHourAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_smartview"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_hour"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/day": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by day",
"description": "Returns statistics grouped by day",
"operationId": "getDayAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_smartview"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_day"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/weekday": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by weekday",
"description": "Returns statistics grouped by weekday",
"operationId": "getWeekdayAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_smartview"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_weekday"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/month": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by month",
"description": "Returns statistics grouped by month",
"operationId": "getMonthAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_smartview"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_month"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/year": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by year",
"description": "Returns statistics grouped by year",
"operationId": "getYearAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_smartview"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_year"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/publisher": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by publisher",
"description": "Returns statistics grouped by publisher",
"operationId": "getPublisherAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_type_2"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/order_by_advertiser_statistics_publisher"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_publisher"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/media": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by media",
"description": "Returns statistics grouped by media",
"operationId": "getMediaToplistAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_type_2"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/order_by_advertiser_statistics_media"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_media"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/program": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by program",
"description": "Returns statistics grouped by program",
"operationId": "getProgramAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_type_2"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/order_by_advertiser_statistics_program"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_program"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/description": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by description",
"description": "Returns statistics grouped by description",
"operationId": "getDescriptionAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_type_2"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/order_by_advertiser_statistics_description"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_description"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/cpc": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by cpc",
"description": "Returns statistics grouped by cpc",
"operationId": "getCpcAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_group_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_type_2"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/order_by_advertiser_statistics_cpc"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_cpc"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/ad": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by ad",
"description": "Returns statistics grouped by ad",
"operationId": "getAdAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_type_2"
},
{
"$ref": "#/components/parameters/filter_ad_dimension"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/order_by_advertiser_statistics_ad"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_ad"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/demographic/regions": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by regions data",
"description": "Returns statistics grouped by regions data",
"operationId": "getRegionsAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_ip_country_code"
},
{
"$ref": "#/components/parameters/filter_ip_region_code"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_demographic_region"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/demographic/countries": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by countries data",
"description": "Returns statistics grouped by countries data",
"operationId": "getCountriesAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_account_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_filter_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_program_description"
},
{
"$ref": "#/components/parameters/filter_publisher_description"
},
{
"$ref": "#/components/parameters/filter_transaction_status"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/filter_ad_adgroup_id"
},
{
"$ref": "#/components/parameters/filter_ip_country_code"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_1"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_2"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_3"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_4"
},
{
"$ref": "#/components/parameters/filter_transaction_extra_5"
},
{
"$ref": "#/components/parameters/filter_publisher_commission"
},
{
"$ref": "#/components/parameters/filter_revenue"
},
{
"$ref": "#/components/parameters/filter_used_compensation_code"
},
{
"$ref": "#/components/parameters/filter_advertiser_invoice_reference_number"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_demographic_country"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/device": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get statistics grouped by device",
"description": "Returns statistics grouped by device",
"operationId": "getDeviceAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_device_type_id"
},
{
"$ref": "#/components/parameters/filter_device_model_id"
},
{
"$ref": "#/components/parameters/filter_device_platform_id"
},
{
"$ref": "#/components/parameters/filter_device_browser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_device"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/device_type": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get totalized statistics grouped by device type",
"description": "Returns totalized statistics grouped by device type",
"operationId": "getDeviceTypeAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_device_type_id"
},
{
"$ref": "#/components/parameters/filter_device_platform_id"
},
{
"$ref": "#/components/parameters/filter_device_browser_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_device_type"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/device_platform": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get totalized statistics grouped by device platform (Operating System)",
"description": "Returns totalized statistics grouped by device platform (Operating System)",
"operationId": "getDevicePlatformAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_device_type_id"
},
{
"$ref": "#/components/parameters/filter_device_platform_brand"
},
{
"$ref": "#/components/parameters/filter_device_browser_brand"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_device_platform"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/statistics/device_browser": {
"get": {
"tags": [
"/advertisers/statistics"
],
"summary": "Get totalized statistics grouped by device browser",
"description": "Returns totalized statistics grouped by device browser",
"operationId": "getDeviceBrowserAdvertiserStatistics",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/currency_code"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_category_id"
},
{
"$ref": "#/components/parameters/filter_device_type_id"
},
{
"$ref": "#/components/parameters/filter_device_platform_brand"
},
{
"$ref": "#/components/parameters/filter_device_browser_brand"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statistic_advertiser_device_browser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/product-feeds": {
"get": {
"tags": [
"/advertisers/product-feeds"
],
"summary": "Fetch product feeds list",
"description": "Fetch product feeds list",
"operationId": "getAdvertiserProductFeedsList",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_ids"
},
{
"$ref": "#/components/parameters/filter_standard_ids"
},
{
"$ref": "#/components/parameters/filter_language_codes"
},
{
"$ref": "#/components/parameters/filter_currency_codes"
},
{
"$ref": "#/components/parameters/filter_is_dedicated"
},
{
"$ref": "#/components/parameters/filter_has_last_modified_header"
},
{
"$ref": "#/components/parameters/filter_advertiser_product_feed_status"
},
{
"$ref": "#/components/parameters/filter_advertiser_product_feed_file_type"
},
{
"$ref": "#/components/parameters/filter_datafeed_compression_type"
},
{
"$ref": "#/components/parameters/order_by_product_feed"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_product_feed_list"
}
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/product-feeds"
],
"summary": "Create advertiser product feed",
"description": "Create an advertiser product feed.",
"operationId": "createProductFeedAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_product_feed_create"
}
}
}
},
"responses": {
"201": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/product-feeds/{product_feed_id}": {
"get": {
"tags": [
"/advertisers/product-feeds"
],
"summary": "Fetch the given product feed",
"description": "Fetch the given product feed",
"operationId": "getAdvertiserProductFeed",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/product_feed_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_product_feed"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/product-feeds"
],
"summary": "Update advertiser product feed",
"description": "Update advertiser product feed.",
"operationId": "updateProductFeedAsAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/product_feed_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_product_feed_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/product-feeds"
],
"summary": "Delete advertiser product feed",
"description": "Delete advertiser product feed",
"operationId": "deleteProductFeedAdvertiser",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/product_feed_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/product-feeds/{product_feed_id}/settings": {
"get": {
"tags": [
"/advertisers/product-feeds/settings"
],
"summary": "Fetch product feed settings",
"description": "Fetch settings of the given product feed",
"operationId": "getAdvertiserProductFeedSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/product_feed_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_product_feed_settings"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/{offer_id}": {
"get": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Get marketplace offer",
"description": "Returns a marketplace offer",
"operationId": "getAdvertiserMarketplaceOffer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/marketplace_offer_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_offer_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/top-lists/type": {
"get": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Get marketplace offers grouped by type",
"description": "Returns a group of marketplace offers by type",
"operationId": "getAdvertiserMarketplaceOffersByType",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_media_country_code"
},
{
"$ref": "#/components/parameters/filter_media_language_code"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_advertiser_top_list_type"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/top-lists/recommended": {
"get": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Get marketplace recommended offers suggestions",
"description": "Returns recommended offers suggestions",
"operationId": "getAdvertiserMarketplaceRecommendedOffers",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_media_country_code"
},
{
"$ref": "#/components/parameters/filter_media_language_code"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_advertiser_top_list_recommended"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace": {
"get": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Get marketplace offer summary",
"description": "Returns a set of marketplace offers",
"operationId": "getAllAdvertiserMarketplaceListOffers",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_marketplace_media_type_id"
},
{
"$ref": "#/components/parameters/filter_media_category_id"
},
{
"$ref": "#/components/parameters/filter_country_code"
},
{
"$ref": "#/components/parameters/filter_language_code"
},
{
"$ref": "#/components/parameters/filter_program_id_json"
},
{
"$ref": "#/components/parameters/filter_by_annual_event_id"
},
{
"$ref": "#/components/parameters/filter_marketplace_highlighted"
},
{
"$ref": "#/components/parameters/filter_marketplace_type_id"
},
{
"$ref": "#/components/parameters/filter_currency_code"
},
{
"$ref": "#/components/parameters/filter_marketplace_price"
},
{
"$ref": "#/components/parameters/filter_start_date_json"
},
{
"$ref": "#/components/parameters/filter_end_date_json"
},
{
"$ref": "#/components/parameters/filter_subscribed"
},
{
"$ref": "#/components/parameters/filter_target_group_size"
},
{
"$ref": "#/components/parameters/filter_target_group"
},
{
"$ref": "#/components/parameters/filter_ad_impressions"
},
{
"$ref": "#/components/parameters/filter_ctr"
},
{
"$ref": "#/components/parameters/filter_conversion_rate"
},
{
"$ref": "#/components/parameters/filter_ecpc"
},
{
"$ref": "#/components/parameters/order_by_marketplace_offers_advertiser"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_offer_advertiser_list"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/offers/{offer_id}/variants/{variant_id}/program-commissions/{program_id}": {
"get": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Get commission of a marketplace offer",
"description": "Returns commission of a marketplace offer",
"operationId": "getAdvertiserMarketplaceOfferCommission",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/marketplace_offer_id"
},
{
"$ref": "#/components/parameters/marketplace_offer_variant_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_offer_advertiser_commission"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/orders": {
"get": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Get all orders",
"description": "Returns a set of orders",
"operationId": "getAllMarketplaceAdvertiserOrders",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_marketplace_order_status"
},
{
"$ref": "#/components/parameters/filter_requested_delivery_date_json"
},
{
"$ref": "#/components/parameters/filter_marketplace_offer_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_by_annual_event_id"
},
{
"$ref": "#/components/parameters/filter_marketplace_type_id"
},
{
"$ref": "#/components/parameters/order_by_marketplace_order"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_order_advertiser_list"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Create a marketplace order",
"description": "Create a marketplace order",
"operationId": "createMarketplaceOrder",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_order_advertiser_create"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/resource_created"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/orders/{order_id}": {
"get": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Get a single order",
"description": "Returns a single order",
"operationId": "getMarketplaceAdvertiserOrders",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/marketplace_order_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_order_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/orders/{order_id}/cancel": {
"put": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Cancel a marketplace order",
"description": "Cancel a marketplace order",
"operationId": "cancelAdvertiserMarketplaceOrder",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/marketplace_order_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_order_advertiser_cancel"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/marketplace/offers/{offer_id}/request-quote": {
"post": {
"tags": [
"/advertisers/marketplace"
],
"summary": "Request custom offer quote",
"description": "Request custom offer quote",
"operationId": "requestCustomQuoteMarketplaceOffer",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/marketplace_offer_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/marketplace_offer_advertiser_custom_quote"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/distribution-groups": {
"get": {
"tags": [
"/advertisers/media/distribution-groups"
],
"summary": "Get distribution groups",
"description": "Returns all the distribution group for media",
"operationId": "getAllDistributionGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_name"
},
{
"$ref": "#/components/parameters/filter_media_group_id_collection"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/distribution_group_advertiser_list"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/distribution-groups"
],
"summary": "Add a distribution group",
"description": "Add a distribution group",
"operationId": "addDistributionGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/distribution-groups/{distribution_group_id}": {
"get": {
"tags": [
"/advertisers/media/distribution-groups"
],
"summary": "Get distribution group",
"description": "Returns a distribution group for media",
"operationId": "getDistributionGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/distribution_group_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/distribution_group_advertiser_list"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/media/distribution-groups"
],
"summary": "Update a distribution group",
"description": "Update a distribution group",
"operationId": "updateDistributionGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/distribution_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/distribution_group_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/resource_created"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/distribution-groups"
],
"summary": "Delete distribution group",
"description": "Delete distribution group",
"operationId": "deleteDistributionGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/distribution_group_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/filter/categories": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all media group categories",
"description": "Returns a set of media group categories",
"operationId": "getAdvertiserMediaGroupCategories",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
},
{
"$ref": "#/components/parameters/order_by_media_group_category"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_category_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Add categories to a media group",
"description": "Add categories to a media group",
"operationId": "addCategoryToAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_category_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Delete categories from a media group",
"description": "Delete categories from a media group",
"operationId": "deleteCategoryAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_category_advertiser_remove"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/filter/countries": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all country codes for the media group",
"description": "Returns a set of country codes for the media group",
"operationId": "getAdvertiserMediaGroupCountries",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
},
{
"$ref": "#/components/parameters/order_by_media_group_country_code"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_filter_country_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Add countries to media group",
"description": "Add countries to media group",
"operationId": "addAdvertiserMediaGroupCountry",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_country_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Delete countries from a media group",
"description": "Delete countries from a media group",
"operationId": "deleteAdvertiserMediaGroupCountry",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_country_advertiser_add"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/filter/languages": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all media group languages",
"description": "Returns a set of media group languages",
"operationId": "getAdvertiserMediaGroupFilterLanguage",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
},
{
"$ref": "#/components/parameters/order_by_media_group_filter_language"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_filter_language_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Add languages to media group",
"description": "Add languages to media group",
"operationId": "addAdvertiserMediaGroupLanguage",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_language_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Remove languages belongs to media group",
"description": "Remove languages belongs to media group",
"operationId": "removeLanguageMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_language_advertiser_remove"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/filter/types": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all media group types",
"description": "Returns a set of media group types",
"operationId": "getAdvertiserMediaGroupTypes",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
},
{
"$ref": "#/components/parameters/order_by_media_group_type"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_type_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Add media type to media group",
"description": "Add media type to media group",
"operationId": "addAdvertiserMediaGroupMediaType",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_advertiser_type_add"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Remove media type belongs to media group",
"description": "Remove media type belongs to media group",
"operationId": "removeAdvertiserMediaGroupMediaType",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_advertiser_type_remove"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/audit-log": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all media group audit log",
"description": "Returns a set of media group audit log",
"operationId": "getAdvertiserMediaGroupAuditLog",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/audit_log_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/media": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all media group media",
"description": "Returns a set of media group media",
"operationId": "getAdvertiserMediaGroupMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
},
{
"$ref": "#/components/parameters/order_by_media_group_media"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_media_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Add media to media group",
"description": "Add media to media group",
"operationId": "addMediaToAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_media_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Remove media from media group",
"description": "Remove media from media group",
"operationId": "removeMediaToAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_media_advertiser_remove"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/publishers": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get all media group publishers",
"description": "Returns a set of media group publishers",
"operationId": "getAdvertiserMediaGroupPublisher",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
},
{
"$ref": "#/components/parameters/order_by_media_group_publisher"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_publisher_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Add publisher to media group",
"description": "Add publisher to media group",
"operationId": "addPublisherToAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_publisher_advertiser_add"
}
}
}
},
"responses": {
"200": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Remove the publisher(s) from the media group",
"description": "Remove the publisher(s) from the media group",
"operationId": "removePublisherFromAdvertiserMediaGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_group_publisher_advertiser_add"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/groups/{media_group_id}/usage": {
"get": {
"tags": [
"/advertisers/media/groups"
],
"summary": "Get media group usage",
"description": "Returns a media group usage",
"operationId": "getAdvertiserMediaGroupUsage",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_group_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_usage_advertiser"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/mute": {
"put": {
"tags": [
"/advertisers/media"
],
"summary": "Mute media",
"description": "Mute media",
"operationId": "muteAdvertiserMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"201": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/advertisers/{advertiser_id}/media/{media_id}/unmute": {
"delete": {
"tags": [
"/advertisers/media"
],
"summary": "Unmute media",
"description": "Unmute media",
"operationId": "unmuteAdvertiserMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/advertisers/{advertiser_id}/media/{media_id}/media-kits": {
"get": {
"tags": [
"/advertisers/media/media-kits"
],
"summary": "Get all media kits",
"description": "Returns a set of media kits",
"operationId": "getAllAdvertiserMediaKitFiles",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_kit_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/media-kits/{media_kit_id}": {
"get": {
"tags": [
"/advertisers/media/media-kits"
],
"summary": "Get a single media kit file",
"description": "Returns a single media-kit",
"operationId": "getAdvertiserMediaKitFile",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/media_kit_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_kit_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/media/{media_id}/media-kits/{media_kit_id}/attachment": {
"get": {
"tags": [
"/advertisers/media/media-kits"
],
"summary": "Download the attached media kit file",
"description": "Download the attached media kit file",
"operationId": "getAdvertiserMediaKitAttachment",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
},
{
"$ref": "#/components/parameters/media_kit_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/access-rules/media-types/{media_type_id}": {
"put": {
"tags": [
"/advertisers/programs/access-rules"
],
"summary": "Update program media type access rule",
"description": "Updates the access rule of a program media type",
"operationId": "updateAdvertiserProgramMediaTypeAccessRule",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/media_type_id"
}
],
"requestBody": {
"description": "Access rule update data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_media_type_access_rule_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"423": {
"$ref": "#/components/responses/423"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/access-rules/media-types": {
"get": {
"tags": [
"/advertisers/programs/access-rules"
],
"summary": "Get program media type access rule",
"description": "Get media type access rule for specific advertiser and program",
"operationId": "getAdvertiserProgramMediaTypeAccessRule",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/filter_partnership_management_access_rule_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_program_media_type_access_rule_list"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/invites": {
"get": {
"tags": [
"/advertisers/media-invites"
],
"summary": "Get all invites",
"description": "Returns a list of all advertiser media invites",
"operationId": "getAllAdvertiserMediaInvites",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_media_invite_status"
},
{
"$ref": "#/components/parameters/order_by_advertiser_media_invite"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_invite_advertiser_list"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/media-invites"
],
"summary": "Invite a media",
"description": "Invite a publisher media to subscribe for advertiser programs",
"operationId": "inviteMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/media_advertiser_invite"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/invites/{invite_id}": {
"delete": {
"tags": [
"/advertisers/media-invites"
],
"summary": "Cancel invite media",
"description": "Cancel an invite media",
"operationId": "cancelInviteMedia",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/invite_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/media/{media_id}/approve": {
"put": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Approve a subscription",
"description": "Approve a subscription",
"operationId": "approveAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/media/{media_id}/disapprove": {
"put": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Reject a subscription",
"description": "Reject a subscription",
"operationId": "disapproveAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subscription_advertiser_disapprove"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/media/{media_id}/disapproval-request": {
"get": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Return pending disapproval request",
"description": "Return pending disapproval request for specific media and advertiser",
"operationId": "PendingDisapproveRequestAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_advertiser_pending_disapproval_request"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Delete the disapproval request",
"description": "Delete the disapproval request",
"operationId": "removeAdvertiserSubscriptionDisapprovalRequest",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/media_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/subscriptions/disapproval-requests": {
"get": {
"tags": [
"/advertisers/subscriptions"
],
"summary": "Return pending disapproval requests",
"description": "Return pending disapproval requests for specific advertiser",
"operationId": "PendingDisapproveRequestsAdvertiserSubscription",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_advertiser_pending_disapproval_request_list"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/commissions": {
"get": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Get program commissions",
"description": "Returns the entire commission structure for this program",
"operationId": "getAdvertiserProgramCommissions",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_commission_advertiser"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Create custom commission group",
"description": "Create custom commission group for the program",
"operationId": "createCustomGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_commission_custom_group_create"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/commissions/audit-log": {
"get": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Get all program commissions audit log",
"description": "Returns a set of program commissions audit log",
"operationId": "getAdvertiserProgramCommissionsAuditLog",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/audit_log_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/commissions/settings": {
"put": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Update commission field",
"description": "Allow for the change of the program commission field",
"operationId": "updateCommissionField",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_commission_settings_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/commissions/default": {
"put": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Update default commission group",
"description": "Update default commission group of the program",
"operationId": "updateDefaultGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_commission_default_group_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/commissions/{commission_group_id}": {
"put": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Update custom commission group",
"description": "Update custom commission group of the program",
"operationId": "updateCustomGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/commission_group_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_commission_custom_group_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Delete custom commission group",
"description": "Delete custom commission group",
"operationId": "deleteCustomGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/commission_group_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"deprecated": true,
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/commissions/{commission_group_id}/remove": {
"put": {
"tags": [
"/advertisers/program/commissions"
],
"summary": "Remove custom commission group",
"description": "Remove custom commission group",
"operationId": "removeCustomGroup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/commission_group_id"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_commission_custom_group_delete"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/descriptions": {
"get": {
"tags": [
"/advertisers/programs/description"
],
"summary": "Get program content",
"description": "Get program content for all languages",
"operationId": "getProgramLanguageDescriptions",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_language_description_list"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/descriptions/{language_code}": {
"put": {
"tags": [
"/advertisers/programs/description"
],
"summary": "Update program content",
"description": "Update program content for the given language",
"operationId": "updateDescriptionToAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/language_code"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_description_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/programs/description"
],
"summary": "Add program content",
"description": "Add program content for the given language",
"operationId": "addDescriptionToAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/language_code"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_description_create"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/programs/description"
],
"summary": "Remove language from program",
"description": "Remove program content for the given language",
"operationId": "removeDescriptionFromAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/language_code"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/deep-linking": {
"get": {
"tags": [
"/advertisers/programs/deep-linking"
],
"summary": "Get program deep link value",
"description": "Get program deep linking",
"operationId": "getProgramDeepLinking",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_deep_linking"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/deep-linking/enable": {
"put": {
"tags": [
"/advertisers/programs/deep-linking"
],
"summary": "Enable program deep linking",
"description": "Enable program deep linking",
"operationId": "enableProgramDeepLinking",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/deep-linking/disable": {
"put": {
"tags": [
"/advertisers/programs/deep-linking"
],
"summary": "Disable program deep linking",
"description": "Disable program deep linking",
"operationId": "disableProgramDeepLinking",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/logo": {
"put": {
"tags": [
"/advertisers/programs"
],
"summary": "Update the program logo",
"description": "Update the program logo",
"operationId": "updateAdvertiserProgramLogo",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_logo_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/start": {
"put": {
"tags": [
"/advertisers/programs"
],
"summary": "Start a program",
"description": "Start a program",
"operationId": "startAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_start"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/stop": {
"put": {
"tags": [
"/advertisers/programs"
],
"summary": "Stop a program",
"description": "Stop a program",
"operationId": "stopAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_stop"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/cancel-start": {
"put": {
"tags": [
"/advertisers/programs"
],
"summary": "Cancel start of a program",
"description": "Cancel the start of a program",
"operationId": "cancelStartAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/cancel-stop": {
"put": {
"tags": [
"/advertisers/programs"
],
"summary": "Cancel stop of a program",
"description": "Cancel stop of a program",
"operationId": "cancelStopAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/restart": {
"put": {
"tags": [
"/advertisers/programs"
],
"summary": "Restart a program",
"description": "Restart a program",
"operationId": "restartAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/criteria/negative-keywords": {
"get": {
"tags": [
"/advertisers/programs/criteria"
],
"summary": "Get all negative keywords",
"description": "Get all negative keyword for advertiser to specific program",
"operationId": "getProgramNegativeKeywordCriteria",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_criteria_negative_keyword_list"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/programs/criteria"
],
"summary": "Add program negative keyword restrictions",
"description": "Create a new negative keyword. Publishers are not allowed to promote your campaign with thiskeyword.",
"operationId": "addProgramNegativeKeywordCriteria",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_criteria_negative_keyword_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/criteria/negative-keywords/{negative_keyword_id}": {
"put": {
"tags": [
"/advertisers/programs/criteria"
],
"summary": "Change program negative keyword restriction",
"description": "Change a negative keyword. Publishers are not allowed to promote your campaign with thiskeyword.",
"operationId": "changeProgramNegativeKeywordCriteria",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/negative_keyword_id"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_criteria_negative_keyword_change"
}
}
}
},
"responses": {
"200": {
"description": "modified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/programs/criteria"
],
"summary": "Delete program negative keyword restriction",
"description": "Delete a negative keyword",
"operationId": "DeleteProgramNegativeKeywordCriteria",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/negative_keyword_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/target/categories": {
"get": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Get all categories for the program",
"description": "Get all categories for the program",
"operationId": "getAdvertiserProgramTargetCategory",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_target_category"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Add categories to a program",
"description": "Add categories to a program",
"operationId": "addCategoryToAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_category_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Remove categories from a program",
"description": "Remove categories from a program",
"operationId": "removeCategoryFromAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_category_remove"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/target/categories/defaults": {
"put": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Update default category of a program",
"description": "Update default category of a program",
"operationId": "updateDefaultCategoryOfAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_category_default_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/target/countries": {
"post": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Add countries to a program",
"description": "Add countries to a program",
"operationId": "addCountryToAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_country_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Remove target countries to a program",
"description": "Remove target countries to a program",
"operationId": "removeCountryToAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_country_remove"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/target/locales": {
"get": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Get all locales for the program",
"description": "Returns a set of locales for the program",
"operationId": "getAdvertiserProgramTargetLocale",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_program_target_locale"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Add locales to a program",
"description": "Add locales to a program",
"operationId": "addLocaleToAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_locale_add"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/programs/target"
],
"summary": "Remove locales from a program",
"description": "Remove locales from a program",
"operationId": "removeLocaleFromAdvertiserProgram",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_locale_remove"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/programs/{program_id}/support": {
"get": {
"tags": [
"/advertisers/programs"
],
"summary": "Get support contact email for a program",
"description": "Returns a support contact email",
"operationId": "getAdvertiserSupportEmail",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/contact_email"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/clicks": {
"get": {
"tags": [
"/advertisers/clicks"
],
"summary": "Get raw click data",
"description": "Returns a set of clicks, limited to a single month",
"operationId": "getAllClicksAdvertiserClicks",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/dateselection_start"
},
{
"$ref": "#/components/parameters/dateselection_end"
},
{
"$ref": "#/components/parameters/filter_click_type"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_program_id"
},
{
"$ref": "#/components/parameters/filter_ad_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/click_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/custom-domains": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get all custom domains",
"description": "Returns a list of custom domains",
"operationId": "getAllCustomDomains",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/custom_domain_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tracking_setting_program_list_custom_domain"
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Add custom domain",
"description": "Returns the verification records for a custom hostname",
"operationId": "addTrackingSettingsProgramCustomDomain",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_settings_program_custom_domain_create"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/custom-domains/{custom_domain_id}/verify": {
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Verify custom domain",
"description": "Verifies the ownership of a custom hostname",
"operationId": "verifyTrackingSettingsProgramCustomDomain",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/custom_domain_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/custom-domains/{custom_domain_id}": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get a custom domain",
"description": "Returns a custom domain",
"operationId": "getCustomDomain",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/custom_domain_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_setting_program_custom_domain_with_links"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Delete the custom domain state",
"description": "Deletes a custom hostname",
"operationId": "deleteTrackingSettingsProgramCustomDomain",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/custom_domain_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/custom-domains/{custom_domain_id}/refresh": {
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Refresh the custom domain state",
"description": "Refreshes the initializing and verification state of a custom hostname",
"operationId": "refreshTrackingSettingsProgramCustomDomain",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/custom_domain_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/ip-block": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get all IP blocks",
"description": "Returns a list of IP blocks",
"operationId": "getAllAdvertiserIpBlocks",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_block_status"
},
{
"$ref": "#/components/parameters/filter_block_name"
},
{
"$ref": "#/components/parameters/filter_block_ip_from"
},
{
"$ref": "#/components/parameters/filter_block_ip_to"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_ip_block_list"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Add IP address block",
"description": "Add IP addresses to allow or block transactions",
"operationId": "addAdvertiserIpBlock",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_ip_block_add"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/ip-block/{ip_block_id}": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get a single IP block",
"description": "Returns a single IP block",
"operationId": "getSingleAdvertiserIpBlock",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ip_block_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_ip_block"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Update an IP address block",
"description": "Update an IP addresses to allow or block transactions",
"operationId": "updateIpBlock",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ip_block_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_ip_block_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Delete an IP address block",
"description": "Delete an IP address block",
"operationId": "deleteIpBlock",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/ip_block_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get advertiser tracking settings",
"description": "Get advertiser tracking settings",
"operationId": "getAdvertiserTrackingSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_tracking_settings"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Update advertiser tracking level",
"description": "Update advertiser tracking level",
"operationId": "updateAdvertiserTrackingLevel",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_level_advertiser_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/media-types": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Fetch tracking settings media types for a program",
"description": "Fetch media types list",
"operationId": "getTrackingSettingsProgramMediaTypes",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_tracking_settings_media_type_list"
}
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Add media type tracking settings",
"description": "Add a media type tracking settings",
"operationId": "addTrackingSettingsProgramMediaType",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tracking_settings_program_media_type_create"
}
}
}
},
"responses": {
"201": {
"description": "created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_created"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/measurement": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get tracking settings measurement for a program",
"description": "Get tracking settings measurement for a program",
"operationId": "getTrackingSettingsProgramMeasurement",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_tracking_settings_measurement"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Update tracking settings measurement for a program",
"description": "Update tracking settings measurement for a program",
"operationId": "updateTrackingSettingsProgramMeasurement",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_tracking_settings_measurement_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/transaction-unique": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get tracking settings transaction unique for a program",
"description": "Get tracking settings transaction unique for a program",
"operationId": "getTrackingSettingsProgramTransactionUnique",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_tracking_settings_transaction_unique"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Update tracking settings transaction unique for a program",
"description": "Update tracking settings transaction unique for a program",
"operationId": "updateTrackingSettingsProgramTransactionUnique",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_tracking_settings_transaction_unique_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/shopping-cart-lock": {
"get": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Get tracking settings shopping cart lock for a program",
"description": "Get tracking settings shopping cart lock for a program",
"operationId": "getTrackingSettingsProgramShoppingCartLock",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_tracking_settings_shopping_cart_lock"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Update tracking settings shopping cart lock for a program",
"description": "Update tracking settings shopping cart lock for a program",
"operationId": "updateTrackingSettingsProgramShoppingCartLock",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_tracking_settings_shopping_cart_lock_update"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/tracking-settings/programs/{program_id}/media-types/{media_type_id}": {
"delete": {
"tags": [
"/advertisers/tracking-settings"
],
"summary": "Remove media type tracking settings",
"description": "Remove a media type tracking settings",
"operationId": "removeTrackingSettingsProgramMediaType",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
},
{
"$ref": "#/components/parameters/media_type_id"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/programs/{program_id}/approval/automation": {
"put": {
"tags": [
"/advertisers/transactions/programs"
],
"summary": "Automate advertiser approval",
"description": "Automate approval",
"operationId": "AutomateAdvertiserApproval",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"requestBody": {
"description": "Automate approval configuration data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/program_automate_approval"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/programs/{program_id}/approval/automation/enable": {
"put": {
"tags": [
"/advertisers/transactions/programs"
],
"summary": "Enable approval settings",
"description": "Enable approval settings",
"operationId": "enableApprovalSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/transactions/programs/{program_id}/approval/automation/disable": {
"put": {
"tags": [
"/advertisers/transactions/programs"
],
"summary": "Disable approval settings",
"description": "Disable approval settings",
"operationId": "disableApprovalSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/program_id"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resource_modified"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/change-proposals": {
"get": {
"tags": [
"/advertisers/change-proposals"
],
"summary": "List change proposals",
"description": "Returns all change proposals for the authenticated advertiser user",
"operationId": "advertiserGetAllChangeProposals",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
},
{
"name": "aggregate_id",
"in": "query",
"description": "Filter by the id of the aggregate the change was proposed for.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "program_id",
"in": "query",
"description": "Filter by the program whose changes are returned. A program holding no changeable aggregate returns an empty list.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "aggregate_type_name",
"in": "query",
"description": "Filter by aggregate type. Accepts an exact name (e.g. program.commission) or a name holding a wildcard (e.g. program.*). A value naming no type returns an empty list.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "approval_status",
"in": "query",
"description": "Filter by approval status. Multiple values are written comma separated (e.g. pending,approved) and match any of them. A value naming no status returns an empty list.",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pending",
"approved",
"applied",
"rejected",
"canceled"
]
}
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"type",
"created_at",
"modified_at",
"approved_at",
"apply_order"
]
}
},
{
"$ref": "#/components/parameters/order_direction"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/change_proposal_advertiser_list"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/change-proposals/{id}": {
"get": {
"tags": [
"/advertisers/change-proposals"
],
"summary": "Get change proposal",
"description": "Returns a single change proposal",
"operationId": "advertiserGetChangeProposalById",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/change_proposal_advertiser"
}
}
}
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"/advertisers/change-proposals"
],
"summary": "Cancel change proposal",
"description": "Cancels a pending change proposal",
"operationId": "advertiserCancelChangeProposal",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "resource modified",
"content": {
"application/json": {
"schema": {
"required": [
"id",
"location"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"location": {
"type": "string",
"format": "uri"
}
},
"type": "object"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/finance/invoices": {
"get": {
"tags": [
"/advertisers/financial"
],
"summary": "Get all finance invoices",
"description": "Returns a set of finance invoices",
"operationId": "getAllAdvertiserFinanceInvoices",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_start_date"
},
{
"$ref": "#/components/parameters/filter_end_date"
},
{
"$ref": "#/components/parameters/filter_finance_advertiser_invoice_number"
},
{
"$ref": "#/components/parameters/filter_finance_advertiser_invoice_status"
},
{
"$ref": "#/components/parameters/filter_finance_advertiser_invoice_order"
},
{
"$ref": "#/components/parameters/order_direction"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_financial_invoice_list"
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/finance/invoices/{invoice_number}": {
"get": {
"tags": [
"/advertisers/financial"
],
"summary": "Get finance invoice by number",
"description": "Returns finance invoice by number",
"operationId": "getAdvertiserFinanceInvoice",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/invoice_number"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/advertiser_financial_invoice_list"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/financial/invoices/{invoice_number}": {
"get": {
"tags": [
"/advertisers/financial"
],
"summary": "Download invoice",
"description": "Download invoice file",
"operationId": "downloadAdvertiserFinanceInvoice",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/invoice_number"
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/financial/invoice-settings": {
"put": {
"tags": [
"/advertisers/financial"
],
"summary": "Update finance invoice settings",
"description": "Update finance invoice settings",
"operationId": "UpdateAdvertiserFinanceInvoiceSettings",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
}
],
"requestBody": {
"description": "Media approval request delegate",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/financial_invoice_settings"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/success"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"401": {
"$ref": "#/components/responses/401"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/advertisers/{advertiser_id}/lookup/publisher_media": {
"get": {
"tags": [
"/advertisers/lookup"
],
"summary": "Get publishers and media",
"description": "",
"operationId": "getPublisherMediaAdvertiserLookup",
"parameters": [
{
"$ref": "#/components/parameters/advertiser_id"
},
{
"$ref": "#/components/parameters/filter_search_term"
},
{
"$ref": "#/components/parameters/filter_publisher_id"
},
{
"$ref": "#/components/parameters/filter_publisher_name"
},
{
"$ref": "#/components/parameters/filter_media_id"
},
{
"$ref": "#/components/parameters/parameter_media_status"
},
{
"$ref": "#/components/parameters/parameter_publisher_status"
},
{
"$ref": "#/components/parameters/paginator_page"
},
{
"$ref": "#/components/parameters/paginator_per"
}
],
"responses": {
"200": {
"description": "success",
"headers": {
"X-Paginator-Per-Page": {
"description": "Max results per page used",
"schema": {
"type": "integer"
}
},
"X-Paginator-Page": {
"description": "Current page",
"schema": {
"type": "integer"
}
},
"X-Total-Count": {
"description": "Total items available",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lookup_publisher_media_advertiser"
}
}
}
}
},
"204": {
"$ref": "#/components/responses/204"
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"ad_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"adgroup_id": {
"type": "integer"
},
"type": {
"description": "This is the mime type of the ad",
"type": "string",
"enum": [
"image/gif",
"image/jpeg",
"image/jpg",
"image/png",
"text/html",
"text/plain"
]
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"content": {
"type": "string"
},
"url": {
"type": "string"
},
"ad_url": {
"description": "Url where this ad is hosted",
"type": "string"
},
"click_url": {
"description": "Tracking/deeplink url for this ad",
"type": "string"
},
"status": {
"description": "This is the status of the ad",
"type": "string",
"enum": [
"active",
"deleted",
"hidden",
"inactive",
"system"
]
},
"system_type": {
"type": "string"
},
"location": {
"type": "string",
"enum": [
"local",
"remote"
]
},
"last_modified": {
"type": "string",
"format": "date-time"
},
"last_modified_username": {
"type": "string"
}
},
"type": "object"
},
"ad_attachment": {
"properties": {
"filename": {
"type": "string"
},
"size": {
"type": "integer"
},
"content_type": {
"type": "string"
}
},
"type": "object"
},
"ad_group_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"url": {
"type": "string"
},
"media_group_id": {
"type": "integer"
},
"annual_event_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"ad_count": {
"type": "integer"
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"last_modified": {
"type": "string",
"format": "date-time"
},
"status": {
"description": "This is the status of the ad group",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_group_advertiser_create": {
"required": [
"name",
"program_id"
],
"properties": {
"program_id": {
"type": "integer"
},
"url": {
"type": "string"
},
"media_group_id": {
"type": "integer"
},
"annual_event_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"status": {
"description": "This is the status of the ad group",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_group_advertiser_update": {
"properties": {
"url": {
"type": "string"
},
"media_group_id": {
"type": "integer"
},
"annual_event_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"status": {
"description": "This is the status of the ad group",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_group_summary": {
"properties": {
"adgroup_id": {
"type": "integer"
},
"active": {
"type": "integer"
},
"inactive": {
"type": "integer"
}
},
"type": "object"
},
"ad_html": {
"required": [
"height",
"html",
"width"
],
"properties": {
"html": {
"type": "string"
},
"tokens": {
"description": "Use the /common/uploads service to obtain token",
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"description": "URL for the link of the ad, ie: https://domain.com/product (defaults to the URL used by the adgroup)",
"type": "string"
},
"status": {
"description": "Status of the ad (defaults to 'active')",
"type": "string",
"enum": [
"active",
"inactive"
]
},
"width": {
"description": "Width in pixels, max 15360 (16K)",
"type": "integer"
},
"height": {
"description": "Height in pixels, max 15360 (16K)",
"type": "integer"
}
},
"type": "object"
},
"ad_image": {
"required": [
"token"
],
"properties": {
"token": {
"description": "Use the /common/uploads service to obtain token (max 500KB)",
"type": "string"
},
"url": {
"description": "URL for the link of the ad[[COMMA] ie: https://domain.com/product (defaults to the URL used bythe ad group)",
"type": "string"
},
"status": {
"description": "Status of the ad (defaults to 'active')",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_image_update": {
"properties": {
"token": {
"description": "Use the /common/uploads service to obtain token (max 500KB)",
"type": "string"
},
"url": {
"description": "URL for the link of the ad[[COMMA] ie: https://domain.com/product (defaults to the URL used bythe ad group)",
"type": "string"
},
"status": {
"description": "Status of the ad (defaults to 'active')",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_remote": {
"required": [
"remote_url"
],
"properties": {
"remote_url": {
"description": "Location of the ad, ie: https://domain.com/images/photo.png",
"type": "string"
},
"url": {
"description": "URL for the link of the ad[[COMMA] ie: https://domain.com/product (defaults to the URL used bythe ad group)",
"type": "string"
},
"status": {
"description": "Status of the ad (defaults to 'active')",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_remote_update": {
"properties": {
"remote_url": {
"description": "Location of the ad, ie: https://domain.com/images/photo.png",
"type": "string"
},
"url": {
"description": "URL for the link of the ad, ie: https://domain.com/product (defaults to the URL used by the adgroup)",
"type": "string"
},
"status": {
"description": "Status of the ad (defaults to 'active')",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_text": {
"required": [
"text"
],
"properties": {
"text": {
"description": "Text for the link of the ad, ie: My great product",
"type": "string"
},
"url": {
"description": "URL for the link of the ad, ie: https://domain.com/product (defaults to the URL used by the adgroup)",
"type": "string"
},
"status": {
"description": "Status of the ad (defaults to 'active')",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"ad_text_update": {
"properties": {
"text": {
"description": "Text for the link of the ad, ie: My great product",
"type": "string"
},
"url": {
"description": "URL for the link of the ad, ie: https://domain.com/product (defaults to the URL used by the adgroup)",
"type": "string"
},
"status": {
"description": "Status of the ad (defaults to 'active')",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"advertiser": {
"properties": {
"id": {
"type": "integer"
},
"customer_number": {
"type": "string"
},
"company_name": {
"type": "string"
},
"name": {
"type": "string"
},
"tracking_level": {
"type": "string"
},
"agreement_terms": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"subscription_auto_approval_days": {
"type": "integer"
},
"subscription_auto_approval_days_postpone": {
"type": "integer"
},
"subscription_auto_approval_status": {
"type": "string",
"enum": [
"approved",
"canceled"
]
}
},
"type": "object"
},
"advertiser_ad_with_deeplink": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"base_url": {
"type": "string"
},
"destination": {
"type": "string"
},
"modified_username": {
"type": "string"
},
"default": {
"type": "boolean"
},
"modified_date": {
"type": "string",
"format": "date"
}
},
"type": "object"
},
"advertiser_ad_with_deeplink_body": {
"required": [
"base_url",
"program_id"
],
"properties": {
"program_id": {
"type": "integer"
},
"base_url": {
"type": "string"
},
"destination": {
"type": "string"
}
},
"type": "object"
},
"advertiser_add": {
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"advertiser_address": {
"properties": {
"country_code": {
"type": "string"
},
"country_id": {
"type": "integer"
},
"address_line_1": {
"description": "street address",
"type": "string"
},
"address_line_2": {
"description": "apartment, suite or space number (or any other designation not literally part of the physicaladdress)",
"type": "string"
},
"house_number": {
"type": "integer"
},
"house_number_additive": {
"type": "string"
},
"city": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"modified_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"modified_username": {
"type": "string"
}
},
"type": "object"
},
"advertiser_address_history": {
"properties": {
"id": {
"type": "integer"
},
"country_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"address_line_1": {
"type": "string"
},
"address_line_2": {
"type": "string"
},
"house_number": {
"type": "integer"
},
"house_number_additive": {
"type": "string"
},
"city": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"modified_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"modified_username": {
"type": "string"
}
},
"type": "object"
},
"advertiser_address_update": {
"required": [
"country_id"
],
"properties": {
"country_id": {
"type": "integer"
},
"address_line_1": {
"type": "string"
},
"address_line_2": {
"type": "string"
},
"house_number": {
"type": "integer"
},
"house_number_additive": {
"type": "string"
},
"postal_code": {
"type": "string"
}
},
"type": "object"
},
"advertiser_businessinfo": {
"required": [
"company",
"contact_name",
"country_id"
],
"properties": {
"company": {
"type": "string"
},
"tax_number": {
"type": "string"
},
"coc_number": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"country_id": {
"type": "integer"
},
"modified_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"modified_username": {
"type": "string"
}
},
"type": "object"
},
"advertiser_businessinfo_update": {
"required": [
"company",
"contact_name",
"country_id"
],
"properties": {
"company": {
"type": "string"
},
"tax_number": {
"type": "string"
},
"coc_number": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"country_id": {
"type": "integer"
}
},
"type": "object"
},
"advertiser_financial_invoice": {
"properties": {
"invoice_number": {
"type": "integer"
},
"date": {
"type": "string",
"format": "date"
},
"date_due": {
"type": "string",
"format": "date"
},
"date_paid": {
"type": "string",
"format": "date"
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"status": {
"type": "string",
"enum": [
"paid",
"pending"
]
},
"amount": {
"type": "number",
"format": "float"
},
"amount_excl_vat": {
"type": "number",
"format": "float"
},
"vat": {
"type": "number",
"format": "float"
},
"currency_code": {
"type": "string"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_financial_invoice_line"
}
}
},
"type": "object"
},
"advertiser_financial_invoice_line": {
"properties": {
"description": {
"type": "string"
},
"code": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"amount": {
"type": "number",
"format": "float"
},
"amount_excl_vat": {
"type": "number",
"format": "float"
},
"vat": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"advertiser_financial_invoice_list": {
"properties": {
"invoice_number": {
"type": "integer"
},
"date": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date_time_native"
}
},
"date_due": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date_time_native"
}
},
"date_paid": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date_time_native"
}
},
"invoice_period_start": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date_time_native"
}
},
"invoice_period_end": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date_time_native"
}
},
"currency_code": {
"type": "string"
},
"amount": {
"type": "number",
"format": "float"
},
"amount_incl_vat": {
"type": "number",
"format": "float"
},
"vat": {
"type": "number",
"format": "float"
},
"programs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_financial_invoice_program"
}
},
"status": {
"type": "string",
"enum": [
"paid",
"pending"
]
}
},
"type": "object"
},
"advertiser_financial_invoice_program": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_financial_invoice_program_line"
}
}
},
"type": "object"
},
"advertiser_financial_invoice_program_line": {
"properties": {
"period": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date_time_native"
}
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"amount": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"advertiser_payment_info_history": {
"properties": {
"id": {
"type": "integer"
},
"beneficial": {
"description": "Account owner",
"type": "string"
},
"bank": {
"$ref": "#/components/schemas/bank"
},
"modified_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"modified_username": {
"type": "string"
}
},
"type": "object"
},
"advertiser_paymentinfo": {
"properties": {
"beneficial": {
"description": "Account owner",
"type": "string"
},
"bank": {
"$ref": "#/components/schemas/bank"
},
"modified_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"modified_username": {
"type": "string"
}
},
"type": "object"
},
"advertiser_paymentinfo_create": {
"required": [
"bank",
"beneficial",
"currency_code",
"type"
],
"properties": {
"beneficial": {
"description": "Account owner",
"type": "string"
},
"bank": {
"$ref": "#/components/schemas/bank_create"
}
},
"type": "object"
},
"advertiser_paymentinfo_update": {
"properties": {
"beneficial": {
"description": "Account owner",
"type": "string"
},
"bank": {
"$ref": "#/components/schemas/bank_create"
}
},
"type": "object"
},
"advertiser_permission": {
"properties": {
"media_read_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"campaign_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"subscriptions_write_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"statistics_basic_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"statistics_advanced_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"transaction_read_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"transaction_write_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"account_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"support_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"notifications_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"users_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
},
"product_feed_search_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission_detail"
}
}
},
"type": "object"
},
"advertiser_product_feed": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"ad_id": {
"type": "integer"
},
"standard_id": {
"type": "integer"
},
"currency_code": {
"type": "string"
},
"language_code": {
"type": "string"
},
"distribution_group_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"create_date": {
"type": "string"
},
"last_download_date": {
"type": "string"
},
"last_modified_date": {
"type": "string"
},
"last_check_date": {
"type": "string"
},
"last_run_date": {
"type": "string"
},
"next_run_date": {
"type": "string"
},
"products_raw": {
"type": "integer"
},
"products_filtered": {
"type": "integer"
},
"products_live": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"active",
"pending",
"rejected"
]
},
"location": {
"type": "string"
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"file_type": {
"type": "string",
"enum": [
"api",
"csv",
"xml"
]
},
"file_compression": {
"type": "string",
"enum": [
"gz",
"zip"
]
},
"offering_type": {
"type": "string",
"enum": [
"product",
"service"
]
},
"notification_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"advertiser_product_feed_create": {
"required": [
"currency_code",
"distribution_group_id",
"language_code",
"locale_ids",
"name",
"program_id",
"standard_id"
],
"properties": {
"program_id": {
"type": "integer"
},
"standard_id": {
"type": "integer"
},
"distribution_group_id": {
"type": "integer",
"nullable": true
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"currency_code": {
"type": "string"
},
"language_code": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string",
"nullable": true
},
"offering_type": {
"type": "string",
"enum": [
"product",
"service"
]
}
},
"type": "object"
},
"advertiser_product_feed_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_product_feed"
}
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aggregation"
}
}
},
"type": "object"
},
"advertiser_product_feed_settings": {
"properties": {
"encoding_id": {
"type": "integer"
},
"location": {
"type": "string"
},
"file_type": {
"type": "string",
"enum": [
"api",
"csv",
"xml"
]
},
"compression_type": {
"type": "string",
"enum": [
"gz",
"zip"
],
"nullable": true
},
"csv_settings": {
"$ref": "#/components/schemas/product_feed_setting_csv_source"
},
"xml_settings": {
"$ref": "#/components/schemas/product_feed_setting_xml_source"
},
"api_settings": {
"$ref": "#/components/schemas/product_feed_setting_api_source"
}
},
"type": "object"
},
"advertiser_product_feed_update": {
"properties": {
"standard_id": {
"type": "integer"
},
"distribution_group_id": {
"type": "integer",
"nullable": true
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"currency_code": {
"type": "string"
},
"language_code": {
"type": "string"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"offering_type": {
"type": "string",
"enum": [
"product",
"service"
]
}
},
"type": "object"
},
"advertiser_program_media_type_access_rule": {
"properties": {
"id": {
"type": "string"
},
"media_type_id": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"allow",
"deny"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"active"
]
},
"explanation": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"advertiser_program_media_type_access_rule_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_program_media_type_access_rule"
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"advertiser_program_target_locale": {
"description": "Advertiser program target locale",
"properties": {
"locale_id": {
"type": "string"
},
"code": {
"type": "string"
}
},
"type": "object"
},
"advertiser_publisher_user": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"image": {
"type": "string"
}
},
"type": "object"
},
"advertiser_questionnaire_content": {
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"language_code": {
"type": "string"
}
},
"type": "object"
},
"advertiser_questionnaire_media": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_questionnaire_content"
}
},
"completed": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_media"
}
}
},
"type": "object"
},
"advertiser_questionnaire_media_question": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"question": {
"type": "string"
},
"clarification": {
"type": "string"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_content"
}
},
"type": {
"type": "string",
"enum": [
"input",
"multiple_choice",
"single_choice",
"text",
"upload"
]
},
"upload_required_files": {
"type": "integer"
},
"required": {
"type": "integer"
},
"upload_file_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gif",
"jpg",
"png"
]
}
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_answer"
}
},
"answer_date": {
"type": "string",
"format": "date-time"
},
"answered_by": {
"type": "string"
},
"given_answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_answer_value_media"
}
},
"given_comment": {
"type": "string"
}
},
"type": "object"
},
"advertiser_revenue_share": {
"properties": {
"program_id": {
"type": "number"
},
"media_id": {
"type": "number"
},
"reference": {
"type": "string"
},
"affiliatemarketing_id": {
"type": "string"
},
"date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"program_description": {
"type": "string"
},
"publisher_description": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"advertiser_revenue_share_member": {
"properties": {
"program_id": {
"type": "number"
},
"media_id": {
"type": "number"
},
"reference": {
"type": "string"
},
"date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"date_click": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"program_description": {
"type": "string"
},
"publisher_description": {
"type": "string"
}
},
"type": "object"
},
"advertiser_target_category": {
"description": "Advertiser target category",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"default": {
"type": "boolean"
}
},
"type": "object"
},
"advertiser_tracking_settings": {
"properties": {
"tracking_level": {
"type": "string"
}
},
"type": "object"
},
"advertiser_tracking_settings_measurement": {
"properties": {
"cookie_duration": {
"type": "integer"
},
"database_duration": {
"type": "integer"
},
"fingerprint_duration": {
"type": "integer"
},
"handshake_duration": {
"type": "integer"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"advertiser_tracking_settings_measurement_update": {
"properties": {
"cookie_duration": {
"type": "integer"
},
"database_duration": {
"type": "integer"
},
"fingerprint_duration": {
"type": "integer"
},
"handshake_duration": {
"type": "integer"
}
},
"type": "object"
},
"advertiser_tracking_settings_media_type": {
"properties": {
"media_type_id": {
"type": "integer"
},
"cookie_duration": {
"type": "integer"
},
"database_duration": {
"type": "integer"
},
"fingerprint_duration": {
"type": "integer"
},
"handshake_duration": {
"type": "integer"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"advertiser_tracking_settings_media_type_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/advertiser_tracking_settings_media_type"
}
}
},
"type": "object"
},
"advertiser_tracking_settings_shopping_cart_lock": {
"properties": {
"soft_lock_duration": {
"type": "integer"
},
"hard_lock_duration": {
"type": "integer"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"advertiser_tracking_settings_shopping_cart_lock_update": {
"properties": {
"soft_lock_duration": {
"type": "integer"
},
"hard_lock_duration": {
"type": "integer"
}
},
"type": "object"
},
"advertiser_tracking_settings_transaction_unique": {
"properties": {
"transaction_unique": {
"type": "boolean"
},
"unique_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ip_address",
"program_description",
"program_tag"
]
}
},
"duration": {
"type": "integer"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"advertiser_tracking_settings_transaction_unique_update": {
"properties": {
"transaction_unique": {
"type": "boolean"
},
"unique_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ip_address",
"program_description",
"program_tag"
]
}
},
"duration": {
"type": "integer"
}
},
"type": "object"
},
"aggregation": {
"properties": {
"field": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aggregation_value"
}
}
},
"type": "object"
},
"aggregation_value": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"count": {
"type": "integer"
},
"selected": {
"type": "boolean"
},
"excluded": {
"type": "boolean"
},
"location": {
"type": "string"
}
},
"type": "object"
},
"agreement_term": {
"properties": {
"language_id": {
"type": "integer"
},
"content": {
"type": "string"
}
},
"type": "object"
},
"agreement_terms": {
"properties": {
"id": {
"type": "integer"
},
"questionnaire_id": {
"type": "integer"
},
"terms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agreement_term"
}
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
},
"type": "object"
},
"agreement_terms_publisher": {
"properties": {
"agreement_terms_id": {
"type": "integer"
},
"date": {
"type": "string",
"format": "date"
}
},
"type": "object"
},
"apps_connected": {
"required": [
"id",
"name",
"restricted"
],
"properties": {
"app_id": {
"type": "integer"
},
"app_name": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"modified_username": {
"type": "string"
},
"modified_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"last_activity": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"deletion_reason": {
"type": "string",
"enum": [
"app_deleted",
"manual",
"permission_change"
]
},
"status": {
"type": "string",
"enum": [
"active",
"deleted"
]
},
"developer_name": {
"type": "string"
}
},
"type": "object"
},
"audit_log_account": {
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string"
},
"profile": {
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"audit_log_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"event_name": {
"type": "string"
},
"date": {
"type": "string"
},
"account": {
"$ref": "#/components/schemas/audit_log_account"
},
"login": {
"$ref": "#/components/schemas/audit_log_login"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/audit_log_payload"
}
},
"context": {
"properties": {
"advertiser_id": {
"type": "integer"
}
},
"type": "object"
},
"previous": {
"properties": {
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/audit_log_payload"
}
}
},
"type": "object"
}
},
"type": "object"
},
"audit_log_app": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"developer": {
"$ref": "#/components/schemas/audit_log_developer"
}
},
"type": "object"
},
"audit_log_developer": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"audit_log_login": {
"properties": {
"issuer": {
"type": "string"
},
"audience": {
"type": "string"
},
"ip": {
"type": "string"
},
"system_update_id": {
"type": "integer"
},
"app": {
"$ref": "#/components/schemas/audit_log_app"
}
},
"type": "object"
},
"audit_log_payload": {
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"bank": {
"properties": {
"name": {
"description": "Bank name",
"type": "string"
},
"country_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"account": {
"description": "Iban/bank account",
"type": "string"
},
"bic": {
"type": "string"
}
},
"type": "object"
},
"bank_create": {
"required": [
"account",
"bic",
"country_id",
"name"
],
"properties": {
"name": {
"description": "Bank name",
"type": "string"
},
"country_id": {
"type": "integer"
},
"account": {
"description": "Iban/bank account",
"type": "string"
},
"bic": {
"type": "string"
}
},
"type": "object"
},
"clearinghouse_suppression_email": {
"required": [
"hash"
],
"properties": {
"start_date": {
"description": "Unmutable when set the first time, when omitted insert date is used",
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time"
},
"hash": {
"description": "MD5 hash of email (lowercase) or email. More than 1 allowed, comma separated",
"type": "string"
}
},
"type": "object"
},
"clearinghouse_suppression_list": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"program_ids": {
"description": "Program id's this list is linked to",
"type": "array",
"items": {
"type": "integer"
}
},
"count": {
"description": "Total number of email addresses within this list",
"type": "integer"
}
},
"type": "object"
},
"clearinghouse_suppression_list_add": {
"required": [
"name",
"program_id"
],
"properties": {
"name": {
"type": "string"
},
"program_id": {
"description": "program id to link this list to",
"type": "integer"
}
},
"type": "object"
},
"clearinghouse_suppression_list_program_add": {
"required": [
"program_id"
],
"properties": {
"program_id": {
"description": "Program id to link this list to",
"type": "integer"
}
},
"type": "object"
},
"clearinghouse_suppression_list_programs": {
"properties": {
"suppression_list_id": {
"type": "integer"
},
"program_ids": {
"description": "Program id's this list is linked to",
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"click_advertiser": {
"properties": {
"date": {
"type": "string",
"format": "date"
},
"hour": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"click",
"clickout",
"cpc"
]
},
"program_id": {
"type": "integer"
},
"ad_id": {
"type": "integer"
},
"media_id": {
"type": "integer",
"nullable": true
},
"commission": {
"type": "number",
"nullable": true
},
"raw": {
"type": "integer"
},
"unique": {
"type": "integer"
},
"product_feeds_unique_id": {
"type": "string"
}
},
"type": "object"
},
"compensation": {
"properties": {
"program_id": {
"type": "integer"
},
"cpc": {
"type": "number"
},
"compensations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/compensation_rowsetting"
}
}
},
"type": "object"
},
"compensation_rowsetting": {
"properties": {
"id": {
"description": "internal id",
"type": "integer"
},
"name": {
"type": "string"
},
"percentage": {
"description": "Commission percentage",
"type": "number",
"format": "float"
},
"display_percentage": {
"description": "Display commission percentage, null when not configured",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Commission amount",
"type": "number",
"format": "float"
},
"display_amount": {
"description": "Display commission amount, null when not configured",
"type": "number",
"format": "float",
"nullable": true
}
},
"type": "object"
},
"contact_email": {
"properties": {
"contact_email": {
"type": "string"
}
},
"type": "object"
},
"contract_get": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"document.approved",
"document.completed",
"document.declined",
"document.draft",
"document.external_review",
"document.paid",
"document.rejected",
"document.sent",
"document.viewed",
"document.voided",
"document.waiting_approval",
"document.waiting_pay"
]
},
"date_created": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"date_modified": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"date_completed": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"expiration_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"contract_send": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"date_created": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"date_modified": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"date_completed": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"expiration_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"version": {
"type": "string"
},
"uuid": {
"type": "string"
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contract_send_recipient"
}
}
},
"type": "object"
},
"contract_send_recipient": {
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"recipient_type": {
"type": "string"
},
"signing_order": {
"type": "string"
},
"shared_link": {
"type": "string"
}
},
"type": "object"
},
"date_time_native": {
"properties": {
"date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "date-time"
},
"timezone_type": {
"type": "integer"
},
"timezone": {
"type": "string"
}
},
"type": "object"
},
"distribution_group_advertiser_add": {
"required": [
"media_group_ids",
"name"
],
"properties": {
"name": {
"type": "string"
},
"media_group_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"distribution_group_advertiser_list": {
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"media_group_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"error": {
"properties": {
"error": {
"type": "string"
}
},
"type": "object"
},
"external_profile": {
"required": [
"address",
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"facebook",
"linkedin",
"twitter"
]
},
"address": {
"type": "string"
}
},
"type": "object"
},
"financial_invoice_settings": {
"required": [
"invoice_language_code"
],
"properties": {
"invoice_language_code": {
"type": "string"
}
},
"type": "object"
},
"google_auth_callback": {
"required": [
"code"
],
"properties": {
"code": {
"type": "string"
}
},
"type": "object"
},
"google_permission": {
"properties": {
"id": {
"type": "integer"
},
"google_account": {
"type": "string",
"format": "email"
},
"service": {
"type": "string",
"enum": [
"analytics"
]
},
"permission": {
"type": "string",
"enum": [
"denied",
"granted"
]
}
},
"type": "object"
},
"google_permission_add": {
"required": [
"google_account",
"service"
],
"properties": {
"google_account": {
"type": "string",
"format": "email"
},
"service": {
"type": "string",
"enum": [
"analytics"
]
}
},
"type": "object"
},
"google_permission_update": {
"required": [
"google_account",
"service"
],
"properties": {
"google_account": {
"type": "string",
"format": "email"
},
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"service": {
"type": "string",
"enum": [
"analytics"
]
},
"permission": {
"type": "string",
"enum": [
"denied",
"granted"
]
}
},
"type": "object"
},
"interface_settings": {
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"interface_settings_update": {
"required": [
"value"
],
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"lead": {
"properties": {
"affiliatemarketing_id": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"campaign_id": {
"type": "integer"
},
"campaign_name": {
"type": "string"
},
"lead_id": {
"type": "string"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lead_part"
}
},
"anonymous_ip": {
"type": "string"
},
"ip_hash": {
"type": "string"
},
"device_type_id": {
"type": "integer"
},
"device_model_id": {
"type": "integer"
},
"device_platform_id": {
"type": "integer"
},
"device_browser_id": {
"type": "integer"
}
},
"type": "object"
},
"lead_part": {
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"date_click": {
"type": "string",
"format": "date-time"
},
"ad_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"commission": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"compensation_code": {
"type": "string"
},
"referer_click": {
"type": "string"
},
"revenue": {
"type": "number"
},
"extra_1": {
"type": "string"
},
"extra_2": {
"type": "string"
},
"extra_3": {
"type": "string"
},
"extra_4": {
"type": "string"
},
"extra_5": {
"type": "string"
},
"approval_date": {
"type": "string",
"format": "date"
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"referencenumber": {
"type": "integer"
},
"last_modified": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"lead_v2": {
"required": [
"affiliatemarketing_id",
"program_id",
"questions"
],
"properties": {
"affiliatemarketing_id": {
"type": "string"
},
"date_in": {
"description": "YYYY-MM-DD hh:ii:ss",
"type": "string",
"format": "date-time"
},
"date_out": {
"description": "YYYY-MM-DD hh:ii:ss",
"type": "string",
"format": "date-time"
},
"program_id": {
"type": "integer"
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lead_v2_question"
}
}
},
"type": "object"
},
"lead_v2_question": {
"required": [
"answer",
"question"
],
"properties": {
"question": {
"type": "string"
},
"answer": {
"type": "string"
}
},
"type": "object"
},
"link": {
"required": [
"href",
"rel"
],
"properties": {
"rel": {
"description": "Class Link",
"type": "string"
},
"href": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"DELETE",
"GET",
"PATCH",
"POST",
"PUT"
]
},
"hreflang": {
"description": "The language of the resource the link leads to, as a BCP 47 language tag",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"application/xml",
"application/json",
"text/csv"
]
},
"title": {
"type": "string"
}
},
"type": "object"
},
"lookup_publisher_media_advertiser": {
"properties": {
"publisher_id": {
"type": "integer"
},
"publisher_name": {
"type": "string"
},
"publisher_status": {
"type": "string",
"enum": [
"active",
"deleted"
]
},
"publisher_type": {
"type": "string",
"enum": [
"advertiser",
"internal",
"normal"
]
},
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_status": {
"type": "string",
"enum": [
"active",
"deleted",
"offline"
]
}
},
"type": "object"
},
"mailing_approval_advertiser": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"media_id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"email",
"url"
]
},
"url": {
"type": "string"
},
"sender_name": {
"type": "string"
},
"sender": {
"type": "string"
},
"subject": {
"type": "string"
},
"mailing_type": {
"type": "string",
"enum": [
"cashback",
"newsletters"
]
},
"approval_request_date": {
"type": "string",
"format": "date-time"
},
"send_date": {
"type": "string",
"format": "date"
},
"last_modified": {
"type": "string",
"format": "date-time"
},
"approval_date": {
"type": "string",
"format": "date-time"
},
"approval_user_id": {
"type": "integer"
},
"addressee_count": {
"type": "integer"
},
"estimate_clicks": {
"type": "integer"
},
"description": {
"type": "string"
},
"emails": {
"type": "string"
},
"note": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
}
},
"type": "object"
},
"mailing_approval_update_advertiser": {
"required": [
"note",
"status"
],
"properties": {
"note": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
}
},
"type": "object"
},
"marketplace_image": {
"properties": {
"type": {
"type": "string",
"enum": [
"additional",
"promotion",
"screenshot"
]
},
"location": {
"type": "string"
}
},
"type": "object"
},
"marketplace_offer_advertiser": {
"properties": {
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_type_id": {
"type": "integer"
},
"media_country_code": {
"type": "string"
},
"media_language_code": {
"type": "string"
},
"media_location": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"annual_event_id": {
"type": "integer"
},
"annual_event_name": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"type_id": {
"type": "integer"
},
"type_name": {
"type": "string"
},
"description": {
"type": "string"
},
"target_group_size": {
"type": "integer"
},
"target_group": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"date_from": {
"type": "string",
"format": "date"
},
"date_until": {
"type": "string",
"format": "date"
},
"highlighted": {
"type": "boolean"
},
"ad_impressions": {
"type": "integer"
},
"ctr": {
"type": "number",
"format": "float"
},
"conversion_rate": {
"type": "number",
"format": "float"
},
"ecpc": {
"type": "number",
"format": "float"
},
"delivery_days": {
"type": "integer"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_image"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_variants"
}
}
},
"type": "object"
},
"marketplace_offer_advertiser_commission": {
"properties": {
"program_currency_code": {
"type": "string"
},
"price_in_program_currency": {
"type": "number",
"format": "float"
},
"price_in_program_currency_inclusive": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"marketplace_offer_advertiser_custom_quote": {
"required": [
"message",
"program_id"
],
"properties": {
"program_id": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"marketplace_offer_advertiser_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_advertiser"
}
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aggregation"
}
}
},
"type": "object"
},
"marketplace_offer_advertiser_top_list": {
"properties": {
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_type_id": {
"type": "integer"
},
"media_country_code": {
"type": "string"
},
"media_language_code": {
"type": "string"
},
"media_location": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"annual_event_id": {
"type": "integer"
},
"annual_event_name": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"type_id": {
"type": "integer"
},
"type_name": {
"type": "string"
},
"description": {
"type": "string"
},
"target_group_size": {
"type": "integer"
},
"target_group": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"date_from": {
"type": "string",
"format": "date"
},
"date_until": {
"type": "string",
"format": "date"
},
"highlighted": {
"type": "boolean"
},
"ad_impressions": {
"type": "integer"
},
"ctr": {
"type": "number",
"format": "float"
},
"conversion_rate": {
"type": "number",
"format": "float"
},
"ecpc": {
"type": "number",
"format": "float"
},
"delivery_days": {
"type": "integer"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_image"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_variants"
}
}
},
"type": "object"
},
"marketplace_offer_advertiser_top_list_recommended": {
"properties": {
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_type_id": {
"type": "integer"
},
"media_country_code": {
"type": "string"
},
"media_language_code": {
"type": "string"
},
"media_location": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"annual_event_id": {
"type": "integer"
},
"annual_event_name": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"type_id": {
"type": "integer"
},
"type_name": {
"type": "string"
},
"description": {
"type": "string"
},
"target_group_size": {
"type": "integer"
},
"target_group": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"date_from": {
"type": "string",
"format": "date"
},
"date_until": {
"type": "string",
"format": "date"
},
"highlighted": {
"type": "boolean"
},
"ad_impressions": {
"type": "integer"
},
"ctr": {
"type": "number",
"format": "float"
},
"conversion_rate": {
"type": "number",
"format": "float"
},
"ecpc": {
"type": "number",
"format": "float"
},
"delivery_days": {
"type": "integer"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_image"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_variants"
}
}
},
"type": "object"
},
"marketplace_offer_advertiser_top_list_type": {
"properties": {
"type_id": {
"type": "integer"
},
"type_name": {
"type": "string"
},
"total_offers": {
"type": "integer"
},
"offers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_advertiser_top_list"
}
}
},
"type": "object"
},
"marketplace_offer_variants": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"price": {
"type": "number",
"format": "float"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_variants_attributes"
}
}
},
"type": "object"
},
"marketplace_offer_variants_attributes": {
"properties": {
"icon": {
"type": "string"
},
"description": {
"type": "string"
},
"included": {
"type": "boolean"
}
},
"type": "object"
},
"marketplace_order_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"offer_variant_id": {
"type": "integer"
},
"created_date": {
"type": "string",
"format": "date"
},
"created_user_name": {
"type": "string"
},
"delivery_date": {
"type": "string",
"format": "date"
},
"delivered_by": {
"type": "string"
},
"delivery_attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_order_delivery_attachment"
}
},
"acceptance_date": {
"type": "string",
"format": "date"
},
"accepted_by": {
"type": "string"
},
"requested_delivery_date": {
"type": "string",
"format": "date"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"program_currency": {
"type": "string"
},
"price_in_program_currency": {
"type": "number",
"format": "float"
},
"price_in_program_currency_inclusive": {
"type": "number",
"format": "float"
},
"affiliatemarketing_id": {
"type": "string"
},
"part_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"accepted",
"confirmed",
"declined",
"delivered",
"pending_acceptance"
]
},
"offer": {
"$ref": "#/components/schemas/marketplace_order_advertiser_offer"
}
},
"type": "object"
},
"marketplace_order_advertiser_cancel": {
"required": [
"reason"
],
"properties": {
"reason": {
"type": "string"
}
},
"type": "object"
},
"marketplace_order_advertiser_create": {
"required": [
"offer_variant_id",
"program_id",
"requested_delivery_date"
],
"properties": {
"offer_variant_id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"requested_delivery_date": {
"type": "string",
"format": "date"
}
},
"type": "object"
},
"marketplace_order_advertiser_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_order_advertiser"
}
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aggregation"
}
}
},
"type": "object"
},
"marketplace_order_advertiser_offer": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_type_id": {
"type": "integer"
},
"media_location": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"annual_event_id": {
"type": "integer"
},
"annual_event_name": {
"type": "string"
},
"type_id": {
"type": "integer"
},
"type_name": {
"type": "string"
},
"description": {
"type": "string"
},
"target_group_size": {
"type": "integer"
},
"target_group": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"date_from": {
"type": "string",
"format": "date"
},
"date_until": {
"type": "string",
"format": "date"
},
"ad_impressions": {
"type": "integer"
},
"ctr": {
"type": "number",
"format": "float"
},
"conversion_rate": {
"type": "number",
"format": "float"
},
"ecpc": {
"type": "number",
"format": "float"
},
"delivery_days": {
"type": "integer"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_image"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/marketplace_offer_variants"
}
}
},
"type": "object"
},
"marketplace_order_delivery_attachment": {
"properties": {
"location": {
"type": "string"
},
"content_type": {
"type": "string"
}
},
"type": "object"
},
"media_advertiser": {
"properties": {
"publisher_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"type_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"publisher_name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"category_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"language_id": {
"type": "integer"
},
"subscription_status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"hidden",
"invited",
"open"
]
},
"subscribe_date": {
"type": "string",
"format": "date"
},
"auto_approval_date": {
"type": "string",
"format": "date"
},
"approval_date": {
"type": "string",
"format": "date"
},
"questionnaire_ids_answered": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_advertiser_invite": {
"required": [
"media_id"
],
"properties": {
"media_id": {
"type": "integer"
},
"program_ids": {
"type": "array",
"items": {
"type": "integer"
},
"nullable": true
},
"source_id": {
"type": "integer",
"nullable": true
}
},
"type": "object"
},
"media_advertiser_keywords": {
"properties": {
"keyword": {
"type": "string"
},
"score": {
"type": "integer"
}
},
"type": "object"
},
"media_advertiser_summary": {
"properties": {
"totals_by_subscription_status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_advertiser_summary_totals_by_subscription_status"
}
}
},
"type": "object"
},
"media_advertiser_summary_totals_by_subscription_status": {
"properties": {
"subscription_status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"media_count": {
"type": "integer"
}
},
"type": "object"
},
"media_group_advertiser": {
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"totals": {
"$ref": "#/components/schemas/media_group_advertiser_totals"
}
},
"type": "object"
},
"media_group_advertiser_add": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"media_group_advertiser_filter_totals": {
"properties": {
"media_types": {
"type": "number"
},
"languages": {
"type": "number"
},
"countries": {
"type": "number"
},
"categories": {
"type": "number"
}
},
"type": "object"
},
"media_group_advertiser_totals": {
"properties": {
"media": {
"type": "number"
},
"publishers": {
"type": "number"
},
"filter": {
"$ref": "#/components/schemas/media_group_advertiser_filter_totals"
}
},
"type": "object"
},
"media_group_advertiser_type_add": {
"required": [
"media_type_ids"
],
"properties": {
"media_type_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_advertiser_type_remove": {
"required": [
"media_type_ids"
],
"properties": {
"media_type_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_category_advertiser": {
"properties": {
"id": {
"type": "integer"
}
},
"type": "object"
},
"media_group_category_advertiser_add": {
"properties": {
"category_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_category_advertiser_remove": {
"properties": {
"category_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_country_advertiser_add": {
"required": [
"country_codes"
],
"properties": {
"country_codes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"media_group_filter_country_advertiser": {
"properties": {
"country_code": {
"type": "string"
}
},
"type": "object"
},
"media_group_filter_language_advertiser": {
"properties": {
"language_code": {
"type": "string"
}
},
"type": "object"
},
"media_group_language_advertiser_add": {
"required": [
"language_codes"
],
"properties": {
"language_codes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"media_group_language_advertiser_remove": {
"required": [
"language_code"
],
"properties": {
"language_codes": {
"type": "array",
"items": {
"type": "string"
}
},
"media_type_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_media_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"media_group_media_advertiser_add": {
"properties": {
"media_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_media_advertiser_remove": {
"properties": {
"media_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_publisher_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"media_group_publisher_advertiser_add": {
"properties": {
"publisher_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"media_group_type_advertiser": {
"properties": {
"type_id": {
"type": "integer"
}
},
"type": "object"
},
"media_group_usage_advertiser": {
"properties": {
"programs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_usage_advertiser_program"
}
},
"ad_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_usage_advertiser_program_ad_group"
}
},
"commission_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_usage_advertiser_program_commission_group"
}
},
"distribution_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_group_usage_advertiser_distribution_group"
}
}
},
"type": "object"
},
"media_group_usage_advertiser_distribution_group": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"media_group_usage_advertiser_program": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"media_group_usage_advertiser_program_ad_group": {
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"program_id": {
"type": "number"
}
},
"type": "object"
},
"media_group_usage_advertiser_program_commission_group": {
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"program_id": {
"type": "number"
}
},
"type": "object"
},
"media_invite_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"accepted",
"canceled",
"declined",
"expired",
"invited"
]
},
"invite_date": {
"type": "string",
"format": "datetime"
},
"invite_user_id": {
"type": "integer"
},
"invite_username": {
"type": "string"
},
"expires": {
"type": "string",
"format": "datetime"
},
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_description": {
"type": "string"
},
"media_type_id": {
"type": "string"
},
"media_location": {
"type": "string"
}
},
"type": "object"
},
"media_invite_advertiser_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/media_invite_advertiser"
}
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aggregation"
}
}
},
"type": "object"
},
"media_kit_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"file_location": {
"type": "string"
}
},
"type": "object"
},
"news": {
"required": [
"locale_ids",
"program_id"
],
"properties": {
"id": {
"type": "integer"
},
"source": {
"type": "string",
"enum": [
"campaign",
"daisycon"
]
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"enum": [
"coupon",
"news",
"promotion",
"update"
]
},
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"newsletters": {
"type": "array",
"items": {
"type": "string"
},
"enum": [
"daily",
"weekly"
]
},
"subscribed": {
"type": "string",
"enum": [
"false",
"true"
]
},
"status": {
"type": "string",
"enum": [
"deleted",
"pending",
"public"
]
},
"category_ids": {
"description": "Category ids of selected program",
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"news_advertiser": {
"required": [
"locale_ids",
"program_id"
],
"properties": {
"id": {
"type": "integer"
},
"source": {
"type": "string",
"enum": [
"campaign",
"daisycon"
]
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"enum": [
"coupon",
"promotion",
"update"
]
},
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"newsletters": {
"type": "array",
"items": {
"type": "string"
},
"enum": [
"daily",
"weekly"
]
},
"subscribed": {
"type": "string",
"enum": [
"false",
"true"
]
},
"status": {
"type": "string",
"enum": [
"deleted",
"pending",
"public"
]
},
"category_ids": {
"description": "Category ids of selected program",
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"news_mutable_advertiser": {
"required": [
"date",
"locale_ids",
"program_id",
"text",
"title",
"type"
],
"properties": {
"program_id": {
"description": "On creation archived and deleted programs are not allowed",
"type": "integer"
},
"date": {
"description": "On creation not more than three months from now",
"type": "string",
"format": "date-time"
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"enum": [
"coupon",
"promotion",
"update"
]
},
"title": {
"type": "string"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"notification_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"sender_name": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"level": {
"type": "string",
"enum": [
"major",
"minor",
"normal"
]
},
"source": {
"type": "string",
"enum": [
"admin",
"advertiser",
"system"
]
},
"send_date": {
"type": "string",
"format": "date"
},
"create_date": {
"type": "string",
"format": "date"
},
"recipient": {
"type": "string",
"enum": [
"active",
"selected",
"subscribed"
]
},
"publisher_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"notification_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_content"
}
},
"status": {
"type": "string",
"enum": [
"pending",
"sent"
]
}
},
"type": "object"
},
"notification_advertiser_add": {
"required": [
"notification_content",
"program_id",
"recipient",
"send_date"
],
"properties": {
"program_id": {
"type": "integer"
},
"recipient": {
"type": "string",
"enum": [
"active",
"selected",
"subscribed"
]
},
"send_date": {
"description": "When left empty current date will be used",
"type": "string",
"format": "date-time"
},
"publisher_ids": {
"description": "Only if recipient is 'selected",
"type": "array",
"items": {
"type": "integer"
}
},
"notification_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_content"
}
}
},
"type": "object"
},
"notification_advertiser_update": {
"required": [
"notification_content",
"program_id",
"recipient",
"send_date"
],
"properties": {
"program_id": {
"type": "integer"
},
"recipient": {
"type": "string",
"enum": [
"active",
"selected",
"subscribed"
]
},
"send_date": {
"type": "string",
"format": "date-time"
},
"publisher_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"notification_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_content"
}
}
},
"type": "object"
},
"notification_content": {
"required": [
"language_id",
"text",
"title"
],
"properties": {
"language_id": {
"type": "integer"
},
"title": {
"type": "string"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"notification_receive_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"sender_name": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "integer"
},
"level": {
"type": "string",
"enum": [
"major",
"minor",
"normal"
]
},
"source": {
"type": "string",
"enum": [
"admin",
"advertiser",
"system"
]
},
"send_date": {
"type": "string",
"format": "date"
},
"recipient": {
"type": "string",
"enum": [
"active",
"selected",
"subscribed"
]
},
"notification_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_content"
}
},
"status": {
"type": "string",
"enum": [
"notified",
"read"
]
}
},
"type": "object"
},
"notification_template": {
"properties": {
"id": {
"type": "integer"
},
"advertiser_id": {
"type": "integer"
},
"template_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_template_content"
}
}
},
"type": "object"
},
"notification_template_add": {
"properties": {
"template_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_template_content"
}
}
},
"type": "object"
},
"notification_template_content": {
"required": [
"language_id",
"text",
"title"
],
"properties": {
"language_id": {
"type": "integer"
},
"title": {
"type": "string"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"notification_template_update": {
"properties": {
"template_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification_template_content"
}
}
},
"type": "object"
},
"ownership_verification": {
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"ownership_verification_http": {
"properties": {
"http_url": {
"type": "string"
},
"http_body": {
"type": "string"
}
},
"type": "object"
},
"permission_detail": {
"properties": {
"permission": {
"type": "integer"
},
"access": {
"type": "boolean"
}
},
"type": "object"
},
"phonenumber_advertiser": {
"required": [
"country_id",
"number"
],
"properties": {
"id": {
"type": "integer"
},
"country_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"number": {
"description": "Phone number without country code, leading zero's or plus(+)",
"type": "string"
}
},
"type": "object"
},
"phonenumber_advertiser_update": {
"required": [
"country_id",
"number"
],
"properties": {
"country_id": {
"type": "integer"
},
"number": {
"description": "Phone number without country code, leading zero's or plus(+)",
"type": "string"
}
},
"type": "object"
},
"product_feed_setting_api_source": {
"required": [
"id",
"parameters"
],
"properties": {
"id": {
"type": "integer"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/product_feed_settings_api_settings_parameter"
}
}
},
"type": "object"
},
"product_feed_setting_csv_source": {
"required": [
"csv_explode_id"
],
"properties": {
"csv_enclose_id": {
"type": "integer"
},
"csv_explode_id": {
"type": "integer"
}
},
"type": "object"
},
"product_feed_setting_xml_source": {
"required": [
"xml_item_tag"
],
"properties": {
"xml_item_tag": {
"type": "string"
}
},
"type": "object"
},
"product_feed_settings_api_settings_parameter": {
"required": [
"id",
"value"
],
"properties": {
"id": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"productfeeds_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"media_id": {
"description": "Will be an int if feed is dedicated, else null",
"type": "integer"
},
"standard_id": {
"type": "integer"
},
"currency_id": {
"type": "integer"
},
"language_code": {
"type": "string"
},
"products_raw": {
"type": "integer"
},
"products_filtered": {
"type": "integer"
},
"products_live": {
"type": "integer"
},
"last_download_date": {
"type": "string",
"format": "date-time"
},
"last_modified_date": {
"type": "string",
"format": "date-time"
},
"last_check_date": {
"type": "string",
"format": "date-time"
},
"last_run_date": {
"type": "string",
"format": "date-time"
},
"next_run_date": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string"
},
"file_type": {
"type": "string",
"enum": [
"api",
"csv",
"database",
"json",
"xml"
]
},
"compression_type": {
"type": "string",
"enum": [
"gzip",
"rar",
"zip"
]
},
"encoding": {
"description": "Only available for CSV and XML, JSON is always UTF8",
"type": "string",
"enum": [
"ascii",
"iso88591",
"iso885915",
"utf16",
"utf8",
"windows-1252"
]
},
"csv_enclose": {
"description": "Only available for CSV",
"type": "string",
"enum": [
"circumflex",
"dblquote",
"pipeline",
"quote"
]
},
"csv_delimiter": {
"description": "Only available for CSV",
"type": "string",
"enum": [
"comma",
"hash",
"pipeline",
"semicolon",
"tabulator"
]
},
"item_tag": {
"description": "Only available for JSON and XML",
"type": "string"
},
"error": {
"type": "string"
}
},
"type": "object"
},
"productfeeds_advertiser_feed": {
"properties": {
"product_count": {
"type": "integer"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"productfeeds_advertiser_filters": {
"properties": {
"standard_field_name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"delete_rows",
"select_rows"
]
},
"equation": {
"type": "string",
"enum": [
"empty",
"equal",
"greater",
"greater_equal",
"in",
"less",
"less_equal",
"not_in"
]
},
"value": {
"type": "string"
},
"records_before": {
"type": "integer"
},
"records_after": {
"type": "integer"
}
},
"type": "object"
},
"productfeeds_advertiser_mapping": {
"properties": {
"original_field_name": {
"type": "string"
},
"standard_field_name": {
"type": "string"
},
"is_unique_identifier": {
"type": "string"
},
"field_type": {
"type": "string",
"enum": [
"image",
"standard_field"
]
},
"field_format": {
"type": "string",
"enum": [
"date",
"datetime",
"decimal",
"integer",
"link",
"text",
"time",
"varchar"
]
}
},
"type": "object"
},
"productfeeds_advertiser_mutations": {
"properties": {
"standard_field_name": {
"type": "string"
},
"mutation_count": {
"type": "integer"
},
"original_value": {
"type": "string"
},
"mutations_result": {
"type": "string"
},
"mutations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser_mutations_mutation"
}
}
},
"type": "object"
},
"productfeeds_advertiser_mutations_mutation": {
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"order": {
"type": "integer"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/productfeeds_advertiser_mutations_mutation_parameters"
}
}
},
"type": "object"
},
"productfeeds_advertiser_mutations_mutation_parameters": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"program": {
"properties": {
"id": {
"type": "integer"
},
"advertiser_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"descriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_description"
}
},
"display_url": {
"type": "string"
},
"logo": {
"type": "string"
},
"tracking_duration": {
"description": "duration in days",
"type": "integer"
},
"tracking_segment": {
"description": "tracking domain",
"type": "string"
},
"startdate": {
"type": "string",
"format": "date"
},
"enddate": {
"type": "string",
"format": "date"
},
"primary_category_id": {
"type": "integer"
},
"category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"supply_locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"media_group_id": {
"type": "array",
"items": {
"type": "integer"
}
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"incentive_date": {
"type": "string",
"format": "date",
"deprecated": true
},
"publisher_tag": {
"type": "string",
"enum": [
"false",
"true"
]
},
"productfeed": {
"type": "string",
"enum": [
"false",
"true"
]
},
"deeplink": {
"type": "string",
"enum": [
"false",
"true"
]
},
"deeplink_ads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_deeplinks"
}
},
"provides_data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_provide_data"
}
},
"commission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_commission"
}
},
"currency_code": {
"type": "string"
},
"score": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score"
}
},
"type": {
"type": "string",
"enum": [
"affiliatemarketing",
"leadgeneration",
"subnetwork"
]
},
"subnetwork": {
"$ref": "#/components/schemas/subnetwork"
},
"transaction_approval_time": {
"description": "in days",
"type": "integer"
},
"transaction_approval_type": {
"type": "string",
"enum": [
"month",
"transaction"
]
},
"transaction_approval_status": {
"type": "string",
"enum": [
"approved",
"disapproved"
]
},
"transaction_approval_enabled": {
"type": "boolean"
},
"default_language_id": {
"type": "integer"
},
"default_locale_id": {
"type": "string"
},
"contact_email": {
"type": "string"
}
},
"type": "object"
},
"program_automate_approval": {
"properties": {
"schedule": {
"$ref": "#/components/schemas/program_automate_approval_schedule"
},
"action": {
"type": "string",
"enum": [
"approve",
"disapprove"
]
}
},
"type": "object"
},
"program_automate_approval_schedule": {
"properties": {
"delay": {
"type": "integer"
},
"mode": {
"type": "string",
"enum": [
"daily",
"monthly"
]
}
},
"type": "object"
},
"program_category_add": {
"required": [
"category_ids"
],
"properties": {
"category_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"program_category_default_update": {
"required": [
"category_id"
],
"properties": {
"category_id": {
"type": "integer"
}
},
"type": "object"
},
"program_category_remove": {
"required": [
"category_ids"
],
"properties": {
"category_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"program_commission": {
"description": "Compensations min/max",
"properties": {
"min_fixed": {
"type": "number"
},
"max_fixed": {
"type": "number"
},
"min_ratio": {
"type": "number"
},
"max_ratio": {
"type": "number"
},
"min_cpc": {
"type": "number"
},
"max_cpc": {
"type": "number"
}
},
"type": "object"
},
"program_commission_cost_per_click_create": {
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_cost_per_click_network_commission_create"
}
},
"type": "object"
},
"program_commission_cost_per_click_network_commission_create": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "If not passed, defaults will be applied",
"type": "string",
"enum": [
"margin",
"percentage"
]
},
"value": {
"description": "If not passed, defaults will be applied",
"type": "number",
"format": "float"
}
},
"type": "object"
},
"program_commission_cost_per_click_network_commission_update": {
"properties": {
"type": {
"description": "If not passed, defaults will be applied",
"type": "string",
"enum": [
"margin",
"percentage"
]
},
"value": {
"description": "If not passed, defaults will be applied",
"type": "number",
"format": "float"
}
},
"type": "object"
},
"program_commission_cost_per_click_update": {
"properties": {
"amount": {
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_cost_per_click_network_commission_update"
}
},
"type": "object"
},
"program_commission_custom_group_commission_rows_create": {
"required": [
"default"
],
"properties": {
"default": {
"$ref": "#/components/schemas/program_commission_custom_group_default_row_create"
},
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_commission_custom_group_custom_row_create"
},
"minItems": 0
}
},
"type": "object"
},
"program_commission_custom_group_commission_rows_update": {
"properties": {
"default": {
"$ref": "#/components/schemas/program_commission_custom_group_default_row_update"
},
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_commission_custom_group_custom_row_update"
}
}
},
"type": "object"
},
"program_commission_custom_group_create": {
"required": [
"commission",
"cpc",
"end",
"hidden",
"media_group_id",
"name",
"priority",
"start",
"status"
],
"properties": {
"name": {
"description": "Name of the custom group, must be unique per program",
"type": "string"
},
"cpc": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_cost_per_click_create"
}
],
"nullable": true,
"description": "Cost per click, set to 'null' to disable"
},
"tiering": {
"$ref": "#/components/schemas/program_commission_tiering_create"
},
"start": {
"description": "Apply the commission only after this date, set to 'null to disable",
"type": "string",
"format": "date",
"nullable": true
},
"end": {
"description": "Apply the commission only before this date, set to 'null' to disable",
"type": "string",
"format": "date",
"nullable": true
},
"priority": {
"description": "The priority for this group, should be between one and the number of groups",
"type": "integer"
},
"commission": {
"$ref": "#/components/schemas/program_commission_custom_group_commission_rows_create"
},
"media_group_id": {
"description": "The media group to apply the commission rates on",
"type": "integer"
},
"hidden": {
"description": "Set the group 'hidden' for publishers. Works in conjuction with status, if set to 'true' thestatus will become active",
"type": "boolean"
},
"status": {
"description": "Inactive commission are not processed",
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"program_commission_custom_group_custom_row_create": {
"required": [
"amount",
"ceiling",
"id",
"percentage",
"threshold"
],
"properties": {
"id": {
"description": "Row id",
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"lead",
"sale"
]
},
"percentage": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"threshold": {
"type": "number",
"format": "float"
},
"ceiling": {
"description": "Can be null",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Can not be null, at least percentage or amount must be set",
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_transaction_network_commission_create"
},
"display_commission": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_display_commission_create"
}
],
"nullable": true
}
},
"type": "object"
},
"program_commission_custom_group_custom_row_update": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"percentage": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"threshold": {
"type": "number",
"format": "float"
},
"ceiling": {
"description": "Can be null",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Can not be null, at least percentage or amount must be set",
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_transaction_network_commission_update"
},
"display_commission": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_display_commission_update"
}
],
"nullable": true
}
},
"type": "object"
},
"program_commission_custom_group_default_row_create": {
"required": [
"amount",
"ceiling",
"percentage",
"threshold"
],
"properties": {
"type": {
"type": "string",
"enum": [
"lead",
"sale"
]
},
"percentage": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"threshold": {
"type": "number",
"format": "float"
},
"ceiling": {
"description": "Can be null",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Can not be null, at least percentage or amount must be set",
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_transaction_network_commission_create"
},
"display_commission": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_display_commission_create"
}
],
"nullable": true
}
},
"type": "object"
},
"program_commission_custom_group_default_row_update": {
"properties": {
"id": {
"type": "integer"
},
"percentage": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"threshold": {
"type": "number",
"format": "float"
},
"ceiling": {
"description": "Can be null",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Can not be null, at least percentage or amount must be set",
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_transaction_network_commission_update"
},
"display_commission": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_display_commission_update"
}
],
"nullable": true
}
},
"type": "object"
},
"program_commission_default_group_commission_rows_update": {
"properties": {
"default": {
"$ref": "#/components/schemas/program_commission_default_group_default_row_update"
},
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_commission_default_group_custom_row_update"
},
"nullable": true
}
},
"type": "object"
},
"program_commission_default_group_cost_per_click_update": {
"properties": {
"amount": {
"type": "number",
"format": "float",
"nullable": true
},
"network": {
"$ref": "#/components/schemas/program_commission_cost_per_click_network_commission_update"
}
},
"type": "object"
},
"program_commission_default_group_custom_row_update": {
"properties": {
"id": {
"type": "integer",
"nullable": true
},
"name": {
"description": "Name of the row, must be unique per program",
"type": "string"
},
"code": {
"description": "Code to be matched, wildcards",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"lead",
"sale"
]
},
"percentage": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"threshold": {
"type": "number",
"format": "float"
},
"ceiling": {
"description": "Can be null",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Can not be null, at least percentage or amount must be set",
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_transaction_network_commission_update"
},
"display_commission": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_display_commission_update"
}
],
"nullable": true
},
"hidden": {
"description": "Note: works in conjuction with status, if set to to true the status will be active",
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"delete": {
"description": "If set to 'true' this commission row will be deleted",
"type": "boolean"
}
},
"type": "object"
},
"program_commission_default_group_default_row_update": {
"properties": {
"type": {
"type": "string",
"enum": [
"lead",
"sale"
]
},
"percentage": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"threshold": {
"type": "number",
"format": "float"
},
"ceiling": {
"description": "Can be null",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Can not be null, at least percentage or amount must be set",
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_transaction_network_commission_update"
},
"display_commission": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_display_commission_update"
}
],
"nullable": true
}
},
"type": "object"
},
"program_commission_default_group_update": {
"properties": {
"cpc": {
"$ref": "#/components/schemas/program_commission_default_group_cost_per_click_update"
},
"commission": {
"$ref": "#/components/schemas/program_commission_default_group_commission_rows_update"
},
"apply_at": {
"description": "Scheduled date/time to apply the change",
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
},
"program_commission_display_commission_create": {
"properties": {
"percentage": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Can be null, at least percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
}
},
"type": "object"
},
"program_commission_display_commission_update": {
"properties": {
"percentage": {
"description": "Omitted: the current value is kept. null: clears the existing percentage. At least one of percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"description": "Omitted: the current value is kept. null: clears the existing amount. At least one of percentage or amount must be set",
"type": "number",
"format": "float",
"nullable": true
}
},
"type": "object"
},
"program_commission_settings_update": {
"required": [
"commission_code_field"
],
"properties": {
"commission_code_field": {
"type": "string",
"enum": [
"adgroup_id",
"extra_1",
"extra_2",
"extra_3",
"extra_4",
"extra_5",
"program_description",
"publisher_description"
]
}
},
"type": "object"
},
"program_commission_tiering_create": {
"required": [
"metric",
"scope"
],
"properties": {
"scope": {
"type": "string",
"enum": [
"media",
"publisher"
]
},
"metric": {
"type": "string",
"enum": [
"count",
"publisher_commission"
]
}
},
"type": "object"
},
"program_commission_transaction_network_commission_create": {
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "If not passed, defaults will be applied",
"type": "string",
"enum": [
"added_transaction_fee",
"fixed_ratio",
"margin",
"percentage",
"transaction_fee"
]
},
"value": {
"description": "If not passed, defaults will be applied",
"type": "number",
"format": "float"
}
},
"type": "object"
},
"program_commission_transaction_network_commission_update": {
"properties": {
"type": {
"description": "If not passed, defaults will be applied",
"type": "string",
"enum": [
"added_transaction_fee",
"fixed_ratio",
"margin",
"percentage",
"transaction_fee"
]
},
"value": {
"description": "If not passed, defaults will be applied",
"type": "number",
"format": "float"
}
},
"type": "object"
},
"program_consumer_delivery": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"number_of_days": {
"type": "integer"
},
"amount": {
"type": "number",
"format": "float"
},
"amount_free_delivery": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"program_consumer_delivery_add": {
"required": [
"amount",
"country_code",
"number_of_days",
"program_id"
],
"properties": {
"program_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"number_of_days": {
"description": "Delivery time",
"type": "integer"
},
"amount": {
"description": "Delivery costs in the programs currency.",
"type": "number",
"format": "float"
},
"amount_free_delivery": {
"description": "Minimum order amount for free delivery.",
"type": "number",
"format": "float"
}
},
"type": "object"
},
"program_consumer_description": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"language_code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"type": "object"
},
"program_consumer_description_add": {
"required": [
"description",
"language_code",
"program_id"
],
"properties": {
"program_id": {
"type": "integer"
},
"language_code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"type": "object"
},
"program_country_add": {
"required": [
"country_codes"
],
"properties": {
"country_codes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"program_country_remove": {
"required": [
"country_codes"
],
"properties": {
"country_codes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"program_criteria_negative_keyword": {
"properties": {
"id": {
"type": "string"
},
"keyword": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"program_criteria_negative_keyword_add": {
"description": "Add negative keyword",
"required": [
"keyword"
],
"properties": {
"keyword": {
"description": "Maximum of 10 words, lowercase",
"type": "string",
"maxLength": 80
}
},
"type": "object"
},
"program_criteria_negative_keyword_change": {
"description": "Change negative keyword",
"required": [
"keyword"
],
"properties": {
"keyword": {
"description": "Maximum of 10 words, lowercase",
"type": "string",
"maxLength": 80
}
},
"type": "object"
},
"program_criteria_negative_keyword_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_criteria_negative_keyword"
}
}
},
"type": "object"
},
"program_deep_linking": {
"properties": {
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"program_deeplinks": {
"description": "Collection of deeplink names and ids",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"program_description": {
"properties": {
"language_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"incentive_description": {
"type": "string",
"deprecated": true
},
"compensationgroup_description": {
"type": "string",
"deprecated": true
},
"additional_conditions": {
"type": "string"
},
"unique_selling_points": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"program_description_create": {
"required": [
"description",
"unique_selling_points"
],
"properties": {
"description": {
"type": "string"
},
"unique_selling_points": {
"description": "Unique selling points",
"type": "array",
"items": {
"type": "string"
}
},
"additional_conditions": {
"description": "Additional conditions",
"type": "string",
"maxLength": 5000,
"nullable": true
}
},
"type": "object"
},
"program_description_update": {
"properties": {
"description": {
"type": "string"
},
"unique_selling_points": {
"description": "Unique selling points",
"type": "array",
"items": {
"type": "string"
}
},
"additional_conditions": {
"description": "Additional conditions",
"type": "string",
"maxLength": 5000,
"nullable": true
}
},
"type": "object"
},
"program_language_description": {
"properties": {
"language_code": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {
"type": "boolean"
},
"unique_selling_points": {
"description": "Unique selling points",
"type": "array",
"items": {
"type": "string"
}
},
"additional_conditions": {
"description": "Additional conditions",
"type": "string",
"maxLength": 5000,
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"program_language_description_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_language_description"
}
}
},
"type": "object"
},
"program_locale_add": {
"required": [
"locale_ids"
],
"properties": {
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"program_locale_remove": {
"required": [
"locale_ids"
],
"properties": {
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"program_logo_update": {
"required": [
"upload_token"
],
"properties": {
"upload_token": {
"type": "string"
},
"purge_cache": {
"properties": {
"query": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
},
"type": "object"
},
"program_media_type_access_rule_update": {
"required": [
"action"
],
"properties": {
"action": {
"type": "string",
"enum": [
"allow",
"deny"
]
},
"explanation": {
"type": "string",
"nullable": true
}
},
"type": "object"
},
"program_provide_data": {
"description": "Advertisers provides extra transaction data",
"properties": {
"field": {
"type": "string",
"enum": [
"age",
"country",
"extra1",
"extra2",
"extra3",
"extra4",
"extra5",
"gender",
"region",
"revenue"
]
},
"name": {
"type": "string"
}
},
"type": "object"
},
"program_referrer_param": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"description": "The name of the referrer parameter",
"type": "string"
},
"value": {
"description": "The value of the referrer parameter to be passed. Placeholders are available like %WEBSITE_ID%,%ACCOUNTNAAM%, %ACCOUNT%, %WEBSITE_SUB_ID%, %WEBSITE_SUB_ID_2%, %WEBSITE_SUB_ID_3%, %IPADRES%,%LINK_ID%, %REF_DOMAIN%, %REFERER%, %MEDIANAME%, %PUBLISHER_ID%, %MEDIA_ID%, %MEDIA_SUB_ID%,%MEDIA_SUB_ID_2%, %MEDIA_SUB_ID_3%, %DCI%, %DAISYCON_ID%, %REQUEST_TIMESTAMP%, %REQUEST_DATE%,%MEDIA_FILTER%, %MEDIA_TYPE%, %ADGROUP_NAME%, %BANNER_SIZE%. These can be combined with other stringslike 123%MEDIA_ID%456 of occur multiple times in a value.",
"type": "string"
}
},
"type": "object"
},
"program_referrer_param_create": {
"required": [
"name"
],
"properties": {
"name": {
"description": "The name of the referrer parameter",
"type": "string"
},
"value": {
"description": "The value of the referrer parameter to be passed. Placeholders are available like %WEBSITE_ID%,%ACCOUNTNAAM%, %ACCOUNT%, %WEBSITE_SUB_ID%, %WEBSITE_SUB_ID_2%, %WEBSITE_SUB_ID_3%, %IPADRES%,%LINK_ID%, %REF_DOMAIN%, %REFERER%, %MEDIANAME%, %PUBLISHER_ID%, %MEDIA_ID%, %MEDIA_SUB_ID%,%MEDIA_SUB_ID_2%, %MEDIA_SUB_ID_3%, %DCI%, %DAISYCON_ID%, %REQUEST_TIMESTAMP%, %REQUEST_DATE%,%MEDIA_FILTER%, %MEDIA_TYPE%, %ADGROUP_NAME%, %BANNER_SIZE%. These can be combined with other stringslike 123%MEDIA_ID%456 of occur multiple times in a value.",
"type": "string"
}
},
"type": "object"
},
"program_referrer_param_update": {
"required": [
"name"
],
"properties": {
"name": {
"description": "The name of the referrer parameter",
"type": "string"
},
"value": {
"description": "The value of the referrer parameter to be passed. Placeholders are available like %WEBSITE_ID%,%ACCOUNTNAAM%, %ACCOUNT%, %WEBSITE_SUB_ID%, %WEBSITE_SUB_ID_2%, %WEBSITE_SUB_ID_3%, %IPADRES%,%LINK_ID%, %REF_DOMAIN%, %REFERER%, %MEDIANAME%, %PUBLISHER_ID%, %MEDIA_ID%, %MEDIA_SUB_ID%,%MEDIA_SUB_ID_2%, %MEDIA_SUB_ID_3%, %DCI%, %DAISYCON_ID%, %REQUEST_TIMESTAMP%, %REQUEST_DATE%,%MEDIA_FILTER%, %MEDIA_TYPE%, %ADGROUP_NAME%, %BANNER_SIZE%. These can be combined with other stringslike 123%MEDIA_ID%456 of occur multiple times in a value.",
"type": "string"
}
},
"type": "object"
},
"program_referrer_settings": {
"properties": {
"referrer_codes_after": {
"description": "Defines where referrer codes are placed in the destination url",
"type": "string"
}
},
"type": "object"
},
"program_referrer_settings_update": {
"required": [
"referrer_codes_after"
],
"properties": {
"referrer_codes_after": {
"description": "Defines where referrer codes are placed in the destination url",
"type": "string"
}
},
"type": "object"
},
"program_score": {
"description": "Campaign scores",
"properties": {
"global": {
"type": "number"
},
"performance": {
"type": "number"
},
"management": {
"type": "number"
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score_profile"
}
},
"program": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score_profile"
}
}
},
"type": "object"
},
"program_score_profile": {
"properties": {
"young": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score_profile_detail"
}
},
"young_adult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score_profile_detail"
}
},
"adult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score_profile_detail"
}
},
"older_adult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score_profile_detail"
}
},
"elderly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_score_profile_detail"
}
}
},
"type": "object"
},
"program_score_profile_detail": {
"properties": {
"male": {
"type": "number"
},
"female": {
"type": "number"
}
},
"type": "object"
},
"program_start": {
"required": [
"date"
],
"properties": {
"date": {
"type": "string",
"format": "date"
}
},
"type": "object"
},
"program_stop": {
"required": [
"date",
"reason"
],
"properties": {
"date": {
"type": "string",
"format": "date"
},
"reason_note": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"enum": [
"end_contract",
"moved_to_competitor",
"no_budget",
"other",
"payment_problems",
"subpar_results",
"webshop_stop"
]
}
},
"type": "object"
},
"program_tracking_segment_update": {
"required": [
"tracking_segment_id"
],
"properties": {
"tracking_segment_id": {
"type": "integer"
}
},
"type": "object"
},
"program_tracking_settings": {
"description": "Program tracking settings",
"properties": {
"referercheck_code": {
"type": "array",
"items": {
"type": "string"
}
},
"referercheck_type": {
"type": "string",
"enum": [
"all_codes_case_insensitive",
"all_codes_case_sensitive",
"one_code_case_insensitive",
"one_code_case_sensitive"
]
},
"referercheck_on_referrer_params": {
"type": "boolean"
},
"tracking_segment_id": {
"type": "integer"
}
},
"type": "object"
},
"program_update": {
"properties": {
"name": {
"type": "string"
},
"display_url": {
"type": "string"
}
},
"type": "object"
},
"promotion_advertiser": {
"properties": {
"id": {
"type": "integer"
},
"ad_id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"annual_event_id": {
"type": "integer"
},
"language_code": {
"description": "ISO 3166-1 alpha-2",
"type": "string"
},
"name": {
"type": "string"
},
"consumer_description": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"amount",
"free_item",
"free_shipping",
"other",
"percentage",
"stack_discount"
]
},
"currency_code": {
"description": "ISO 4217",
"type": "string"
},
"discount": {
"type": "number"
},
"code": {
"type": "string"
},
"start_date": {
"type": "string",
"format": "datetime"
},
"end_date": {
"type": "string",
"format": "datetime"
},
"visible_date": {
"type": "string",
"format": "datetime"
},
"terms": {
"type": "string"
},
"url": {
"type": "string"
},
"target_locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"available_for": {
"type": "string",
"enum": [
"daisycon",
"everyone",
"specific_media"
]
},
"available_for_media_id": {
"type": "integer"
},
"modified_date": {
"description": "YYYY-MM-DD HH:ii:ss",
"type": "string",
"format": "datetime"
},
"modified_username": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"pending"
]
}
},
"type": "object"
},
"promotion_advertiser_add": {
"required": [
"available_for",
"consumer_description",
"end_date",
"language_code",
"name",
"program_id",
"start_date",
"type",
"url"
],
"properties": {
"program_id": {
"type": "integer"
},
"annual_event_id": {
"type": "integer"
},
"language_code": {
"description": "ISO 3166-1 alpha-2",
"type": "string"
},
"name": {
"type": "string"
},
"consumer_description": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"amount",
"free_item",
"free_shipping",
"other",
"percentage",
"stack_discount"
]
},
"discount": {
"type": "number"
},
"currency_code": {
"description": "ISO 4217",
"type": "string"
},
"code": {
"type": "string"
},
"start_date": {
"type": "string",
"format": "datetime"
},
"end_date": {
"type": "string",
"format": "datetime"
},
"visible_date": {
"type": "string",
"format": "datetime"
},
"terms": {
"type": "string"
},
"url": {
"type": "string"
},
"target_locale_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"available_for": {
"type": "string",
"enum": [
"daisycon",
"everyone",
"specific_media"
]
},
"available_for_media_id": {
"type": "integer"
}
},
"type": "object"
},
"publisher": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"publisher_detail": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"relation_type": {
"type": "string"
},
"chamber_of_commerce": {
"type": "string"
},
"company_name": {
"type": "string"
},
"beneficial": {
"type": "string"
},
"address": {
"$ref": "#/components/schemas/publisher_detail_address"
}
},
"type": "object"
},
"publisher_detail_address": {
"properties": {
"country_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"address_line_1": {
"type": "string"
},
"address_line_2": {
"type": "string"
},
"city": {
"type": "string"
},
"zipcode": {
"type": "string"
}
},
"type": "object"
},
"publisher_document": {
"properties": {
"id": {
"type": "integer"
},
"publisher_id": {
"type": "string"
},
"name": {
"type": "string"
},
"file_name": {
"type": "string"
},
"date": {
"type": "string",
"format": "datetime"
},
"file_url": {
"description": "File download location",
"type": "string"
},
"file_size": {
"description": "File size in bytes",
"type": "number",
"format": "float"
}
},
"type": "object"
},
"questionnaire_question_answer": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_answer_content"
}
},
"comment_required": {
"type": "boolean"
}
},
"type": "object"
},
"questionnaire_question_answer_content": {
"properties": {
"answer": {
"type": "string"
},
"language_code": {
"type": "string"
}
},
"type": "object"
},
"questionnaire_question_answer_value_media": {
"properties": {
"value": {
"description": "Contains the given answer text (string) or id (int) in case of choises or file url (string) incase of upload",
"type": "string"
},
"comment": {
"description": "Optional answer comment",
"type": "string"
},
"filename": {
"description": "Optional answer filename",
"type": "string"
}
},
"type": "object"
},
"questionnaire_question_content": {
"properties": {
"question": {
"type": "string"
},
"clarification": {
"type": "string"
},
"language_code": {
"type": "string"
}
},
"type": "object"
},
"questionnaire_question_media": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_content"
}
},
"type": {
"type": "string",
"enum": [
"input",
"multiple_choice",
"single_choice",
"text",
"upload"
]
},
"upload_required_files": {
"type": "integer"
},
"upload_file_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gif",
"jpg",
"png"
]
}
},
"required": {
"type": "integer"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_answer"
}
},
"answer_date": {
"type": "string",
"format": "date-time"
},
"answered_by": {
"type": "string"
},
"answered_ip": {
"type": "string"
},
"given_answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/questionnaire_question_answer_value_media"
}
},
"given_comment": {
"type": "string"
}
},
"type": "object"
},
"recommended_media_advertiser": {
"properties": {
"publisher_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"type_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"publisher_name": {
"type": "string"
},
"location": {
"type": "string"
},
"description": {
"type": "string"
},
"category_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"language_id": {
"type": "integer"
},
"subscription_status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"hidden",
"invited",
"open"
]
},
"subscribe_date": {
"type": "string",
"format": "date"
},
"auto_approval_date": {
"type": "string",
"format": "date"
},
"questionnaire_ids_answered": {
"type": "array",
"items": {
"type": "integer"
}
},
"score": {
"type": "number"
}
},
"type": "object"
},
"resource_created": {
"properties": {
"id": {
"type": "integer"
},
"location": {
"type": "string"
}
},
"type": "object"
},
"resource_modified": {
"properties": {
"id": {
"type": "integer"
},
"location": {
"type": "string"
}
},
"type": "object"
},
"ssl_validation": {
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_ad": {
"properties": {
"ad_id": {
"type": "integer"
},
"ad_group_name": {
"type": "string"
},
"ad_type": {
"type": "string"
},
"ad_size": {
"type": "string"
},
"ad_content": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"ecpc": {
"type": "number"
},
"click_lead": {
"type": "number"
}
},
"type": "object"
},
"statistic_advertiser_cpc": {
"properties": {
"media_id": {
"type": "integer",
"nullable": true
},
"media_name": {
"type": "string",
"nullable": true
},
"media_location": {
"type": "string",
"nullable": true
},
"commission": {
"description": "commission per impression",
"type": "number",
"nullable": true
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_date": {
"properties": {
"date": {
"type": "string",
"format": "date"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_day": {
"properties": {
"day": {
"type": "integer"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_demographic_country": {
"properties": {
"country": {
"type": "string"
},
"ip_country_code": {
"type": "string"
},
"group": {
"description": "optional if group is given",
"type": "string"
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_demographic_region": {
"properties": {
"country": {
"type": "string"
},
"ip_country_code": {
"type": "string"
},
"ip_region_code": {
"type": "string"
},
"region": {
"type": "string"
},
"group": {
"description": "optional if group is given",
"type": "string"
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_description": {
"properties": {
"description": {
"type": "string"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number"
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number"
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number"
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number"
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"ecpc": {
"type": "number"
},
"click_lead": {
"type": "number"
}
},
"type": "object"
},
"statistic_advertiser_device": {
"properties": {
"device_type": {
"type": "string",
"enum": [
"pc",
"phone",
"tablet"
]
},
"device_type_id": {
"type": "integer"
},
"device_browser_id": {
"type": "integer"
},
"device_platform_id": {
"type": "integer"
},
"device_model_id": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number"
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number"
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number"
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number"
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_device_browser": {
"properties": {
"device_browser_brand": {
"description": "Values like: internet explorer, edge, safari, chrome, firefox, etc.",
"type": "string"
},
"click_unique": {
"type": "integer"
},
"transaction_unique": {
"type": "integer"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_device_platform": {
"properties": {
"device_platform_brand": {
"description": "Values like: windows, linux, ios, android, etc.",
"type": "string"
},
"click_unique": {
"type": "integer"
},
"transaction_unique": {
"type": "integer"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_device_type": {
"properties": {
"device_type": {
"type": "string",
"enum": [
"pc",
"phone",
"tablet"
]
},
"device_type_id": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"transaction_unique": {
"type": "integer"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number"
},
"transaction_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_engagement": {
"properties": {
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_type_id": {
"type": "string"
},
"assist_total_count_sum": {
"type": "integer"
},
"assist_count_sum": {
"type": "integer"
},
"assist_commission_sum": {
"type": "number",
"format": "float"
},
"assist_revenue_sum": {
"type": "number",
"format": "float"
},
"assigned_count_sum": {
"type": "integer"
},
"assigned_commission_sum": {
"type": "number",
"format": "float"
},
"assigned_revenue_sum": {
"type": "number",
"format": "float"
},
"contribution_count_sum": {
"type": "integer"
},
"contribution_commission_sum": {
"type": "number",
"format": "float"
},
"contribution_revenue_sum": {
"type": "number",
"format": "float"
},
"contribution_win_sum": {
"type": "number",
"format": "float"
},
"contribution_first_contact_sum": {
"type": "number",
"format": "float"
},
"contribution_avg_position_sum": {
"type": "number",
"format": "float"
},
"contribution_reach_index_sum": {
"type": "number",
"format": "float"
},
"contribution_unique_reach_sum": {
"type": "number",
"format": "float"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_hour": {
"properties": {
"hour": {
"type": "integer"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_media": {
"properties": {
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_location": {
"type": "string"
},
"media_type_id": {
"type": "string"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"ecpc": {
"type": "number"
},
"click_lead": {
"type": "number"
}
},
"type": "object"
},
"statistic_advertiser_month": {
"properties": {
"month": {
"type": "integer"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_program": {
"properties": {
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"ecpc": {
"type": "number"
},
"click_lead": {
"type": "number"
}
},
"type": "object"
},
"statistic_advertiser_publisher": {
"properties": {
"publisher_id": {
"type": "integer"
},
"publisher_name": {
"type": "string"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"ecpc": {
"type": "number"
},
"click_lead": {
"type": "number"
}
},
"type": "object"
},
"statistic_advertiser_weekday": {
"properties": {
"weekday": {
"type": "string",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
]
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number"
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number"
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number"
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number"
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"statistic_advertiser_year": {
"properties": {
"year": {
"type": "integer"
},
"click_raw": {
"type": "integer"
},
"click_unique": {
"type": "integer"
},
"cpc_raw": {
"type": "integer"
},
"cpc_unique": {
"type": "integer"
},
"cpc_amount": {
"type": "number",
"nullable": true
},
"transaction_unique": {
"type": "integer"
},
"transaction_parts": {
"type": "integer"
},
"transaction_amount": {
"type": "number",
"nullable": true
},
"transaction_program_amount": {
"type": "number"
},
"transaction_revenue": {
"type": "number"
},
"transaction_open": {
"type": "integer"
},
"transaction_open_parts": {
"type": "integer"
},
"transaction_open_amount": {
"type": "number",
"nullable": true
},
"transaction_open_program_amount": {
"type": "number"
},
"transaction_approved": {
"type": "integer"
},
"transaction_approved_parts": {
"type": "integer"
},
"transaction_approved_amount": {
"type": "number",
"nullable": true
},
"transaction_approved_program_amount": {
"type": "number"
},
"transaction_disapproved": {
"type": "integer"
},
"transaction_disapproved_parts": {
"type": "integer"
},
"transaction_disapproved_amount": {
"type": "number",
"nullable": true
},
"transaction_disapproved_program_amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"subnetwork": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"subscription_advertiser": {
"required": [
"media_id",
"status"
],
"properties": {
"media_id": {
"type": "integer"
},
"subscribe_date": {
"type": "string",
"format": "date"
},
"approval_date": {
"type": "string",
"format": "date"
},
"approval_name": {
"type": "string"
},
"auto_approval_date": {
"type": "string",
"format": "date"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"subscription_advertiser_disapprove": {
"required": [
""
],
"properties": {
"reason": {
"description": "The public reason for rejecting the subscription request",
"type": "string",
"maxLength": 1000,
"nullable": true
}
},
"type": "object"
},
"subscription_advertiser_hide": {
"properties": {
"advertiser_id": {
"type": "integer"
},
"media_id": {
"type": "integer"
},
"subscribe_date": {
"type": "string",
"format": "date"
},
"auto_approval_date": {
"type": "string",
"format": "date"
},
"hidden": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"type": "object"
},
"subscription_advertiser_pending_disapproval_request": {
"required": [
"effective_at"
],
"properties": {
"effective_at": {
"type": "string",
"format": "date"
}
},
"type": "object"
},
"subscription_advertiser_pending_disapproval_request_item": {
"properties": {
"effective_at": {
"type": "string",
"format": "date"
},
"media_id": {
"type": "integer"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"subscription_advertiser_pending_disapproval_request_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_advertiser_pending_disapproval_request_item"
}
}
},
"type": "object"
},
"subscription_advertiser_postpone": {
"properties": {
"media_id": {
"type": "integer"
},
"subscribe_date": {
"type": "string",
"format": "date"
},
"approval_date": {
"type": "string",
"format": "date"
},
"auto_approval_date": {
"type": "string",
"format": "date"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"success": {
"type": "boolean"
},
"error": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscription_advertiser_postpone_error"
}
}
},
"type": "object"
},
"subscription_advertiser_postpone_error": {
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"success": {
"properties": {
"message": {
"type": "string"
}
},
"type": "object"
},
"system_notification_content": {
"required": [
"language_id",
"text",
"title"
],
"properties": {
"language_id": {
"type": "integer"
},
"title": {
"type": "string"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"system_notification_receive": {
"properties": {
"id": {
"type": "integer"
},
"icon": {
"type": "string"
},
"in_popup": {
"type": "boolean"
},
"closable": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"error",
"info",
"warning"
]
},
"system_notification_content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/system_notification_content"
}
}
},
"type": "object"
},
"ticket": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"counterpart_name": {
"type": "string"
},
"publisher_id": {
"type": "integer"
},
"publisher_name": {
"type": "string"
},
"subject": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string",
"enum": [
"closed",
"open",
"solved"
]
}
},
"type": "object"
},
"ticket_attachment": {
"properties": {
"file_name": {
"type": "string"
},
"content_url": {
"type": "string"
},
"content_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"thumbnails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ticket_attachment_thumbnail"
}
}
},
"type": "object"
},
"ticket_attachment_thumbnail": {
"properties": {
"file_name": {
"type": "string"
},
"content_url": {
"type": "string"
},
"content_type": {
"type": "string"
},
"size": {
"type": "integer"
}
},
"type": "object"
},
"ticket_attachment_token": {
"required": [
"token"
],
"properties": {
"token": {
"type": "string"
}
},
"type": "object"
},
"ticket_comment": {
"properties": {
"body": {
"type": "string"
},
"author_id": {
"type": "integer"
},
"source": {
"type": "string",
"enum": [
"advertiser",
"daisycon",
"publisher"
]
},
"contact_name": {
"type": "string"
},
"contact_image": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ticket_attachment"
}
}
},
"type": "object"
},
"ticket_detail": {
"properties": {
"id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"body": {
"type": "string"
},
"sender": {
"type": "integer"
},
"counterpart_name": {
"type": "string"
},
"publisher_id": {
"type": "integer"
},
"publisher_name": {
"type": "string"
},
"subject": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ticket_comment"
}
}
},
"type": "object"
},
"ticket_reply": {
"required": [
"body"
],
"properties": {
"body": {
"type": "string"
},
"upload_tokens": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"description": "Status ('open', 'solved', 'closed')",
"type": "string",
"enum": [
"closed",
"open",
"solved"
]
}
},
"type": "object"
},
"tracking_ip_block": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"reason": {
"type": "string",
"enum": [
"advertiser",
"call_center",
"misuse",
"other",
"proxy"
]
},
"range_from": {
"type": "string"
},
"range_end": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"allow",
"deny"
]
}
},
"type": "object"
},
"tracking_ip_block_add": {
"required": [
"name",
"range_end",
"range_from",
"reason",
"status"
],
"properties": {
"name": {
"type": "string"
},
"reason": {
"type": "string",
"enum": [
"advertiser",
"call_center",
"misuse",
"other",
"proxy"
]
},
"range_from": {
"type": "string"
},
"range_end": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"allow",
"deny"
]
}
},
"type": "object"
},
"tracking_ip_block_list": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tracking_ip_block"
}
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/aggregation"
}
}
},
"type": "object"
},
"tracking_ip_block_update": {
"properties": {
"name": {
"type": "string"
},
"reason": {
"type": "string",
"enum": [
"advertiser",
"call_center",
"misuse",
"other",
"proxy"
]
},
"range_from": {
"type": "string"
},
"range_end": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"allow",
"deny"
]
}
},
"type": "object"
},
"tracking_level_advertiser_update": {
"required": [
"tracking_level"
],
"properties": {
"tracking_level": {
"type": "string",
"enum": [
"advertiser",
"program"
]
}
},
"type": "object"
},
"tracking_setting_program_custom_domain_with_links": {
"properties": {
"id": {
"type": "string"
},
"domain": {
"type": "string"
},
"ownership_verification": {
"$ref": "#/components/schemas/ownership_verification"
},
"ownership_verification_http": {
"$ref": "#/components/schemas/ownership_verification_http"
},
"ssl_validation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ssl_validation"
}
},
"status": {
"type": "string",
"enum": [
"deleted",
"initializing",
"pending_deletion",
"pending_registration",
"pending_verification",
"registered",
"verified"
]
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"tracking_setting_program_list_custom_domain": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tracking_setting_program_custom_domain_with_links"
}
}
},
"type": "object"
},
"tracking_settings_program_custom_domain_create": {
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string"
}
},
"type": "object"
},
"tracking_settings_program_media_type_create": {
"required": [
"cookie_duration",
"database_duration",
"fingerprint_duration",
"handshake_duration",
"media_type_id"
],
"properties": {
"media_type_id": {
"type": "integer"
},
"cookie_duration": {
"type": "integer"
},
"database_duration": {
"type": "integer"
},
"fingerprint_duration": {
"type": "integer"
},
"handshake_duration": {
"type": "integer"
}
},
"type": "object"
},
"transaction_advertiser": {
"properties": {
"affiliatemarketing_id": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"transaction_id": {
"type": "string"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_advertiser_part"
}
},
"anonymous_ip": {
"type": "string"
},
"ip_hash": {
"type": "string"
},
"device_type_id": {
"type": "integer"
},
"device_model_id": {
"type": "integer"
},
"device_platform_id": {
"type": "integer"
},
"device_browser_id": {
"type": "integer"
}
},
"type": "object"
},
"transaction_advertiser_add": {
"required": [
"date",
"parts",
"program_id",
"transaction_id"
],
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"program_id": {
"type": "integer"
},
"transaction_id": {
"type": "string"
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_advertiser_part_add"
}
}
},
"type": "object"
},
"transaction_advertiser_bulk_approve": {
"required": [
"affiliatemarketing_ids"
],
"properties": {
"affiliatemarketing_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"transaction_advertiser_bulk_assessment": {
"properties": {
"affiliatemarketing_id": {
"type": "string"
},
"part_id": {
"type": "string"
},
"success": {
"type": "boolean"
},
"error": {
"type": "string"
}
},
"type": "object"
},
"transaction_advertiser_bulk_disapprove": {
"required": [
"affiliatemarketing_ids",
"disapprove_reason"
],
"properties": {
"affiliatemarketing_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"disapprove_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
}
},
"type": "object"
},
"transaction_advertiser_engagement": {
"properties": {
"ad_id": {
"type": "integer"
},
"media_id": {
"type": "integer",
"nullable": true
},
"media_name": {
"type": "string",
"nullable": true
},
"media_type_id": {
"type": "string",
"nullable": true
},
"publisher_id": {
"type": "integer",
"nullable": true
},
"publisher_name": {
"type": "string",
"nullable": true
},
"ip_hash": {
"type": "string"
},
"anonymous_ip": {
"type": "string"
},
"ip_country_code": {
"type": "string"
},
"ip_region_code": {
"type": "string"
},
"device_type_id": {
"type": "integer"
},
"device_model_id": {
"type": "integer"
},
"device_platform_id": {
"type": "integer"
},
"device_browser_id": {
"type": "integer"
},
"referer_click": {
"type": "string",
"nullable": true
},
"date_click": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"transaction_advertiser_part": {
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"date_click": {
"type": "string",
"format": "date-time"
},
"media_id": {
"type": "integer",
"nullable": true
},
"media_name": {
"type": "string",
"nullable": true
},
"ad_id": {
"type": "integer"
},
"publisher_description": {
"type": "string",
"nullable": true
},
"program_description": {
"type": "string"
},
"commission": {
"type": "number",
"nullable": true
},
"program_commission": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"compensation_code": {
"type": "string"
},
"referer_click": {
"type": "string",
"nullable": true
},
"revenue": {
"type": "number"
},
"extra_1": {
"type": "string"
},
"extra_2": {
"type": "string"
},
"extra_3": {
"type": "string"
},
"extra_4": {
"type": "string"
},
"extra_5": {
"type": "string"
},
"approval_date": {
"type": "string",
"format": "date"
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"referencenumber": {
"type": "integer"
},
"last_modified": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"transaction_advertiser_part_add": {
"required": [
"commission",
"date",
"media_id",
"program_description",
"publisher_description",
"status"
],
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"media_id": {
"type": "integer"
},
"publisher_description": {
"type": "string"
},
"program_description": {
"type": "string"
},
"commission": {
"type": "number",
"format": "float"
},
"revenue": {
"type": "number"
},
"extra_1": {
"type": "string"
},
"extra_2": {
"type": "string"
},
"extra_3": {
"type": "string"
},
"extra_4": {
"type": "string"
},
"extra_5": {
"type": "string"
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
},
"status": {
"type": "string",
"enum": [
"approved",
"open"
]
}
},
"type": "object"
},
"transaction_advertiser_part_history": {
"properties": {
"mutation_date": {
"type": "string",
"format": "date-time"
},
"compensation_id": {
"type": "integer"
},
"currency_code": {
"type": "string"
},
"commission": {
"type": "number"
},
"revenue": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"modified_name": {
"type": "string"
},
"modified_username": {
"type": "string"
},
"comment": {
"type": "string"
}
},
"type": "object"
},
"transaction_advertiser_part_recalculate": {
"properties": {
"initial_commission": {
"description": "initial (publisher) commission to be recalculate based on compensation settings",
"type": "number"
},
"currency": {
"type": "string"
}
},
"type": "object"
},
"transaction_advertiser_part_update": {
"required": [
"status"
],
"properties": {
"revenue": {
"type": "number"
},
"commission": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
}
},
"type": "object"
},
"transaction_advertiser_update": {
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
}
},
"type": "object"
},
"transaction_attachment": {
"required": [
"date",
"download_url",
"filename",
"note",
"source"
],
"properties": {
"id": {
"type": "integer"
},
"date": {
"type": "string",
"format": "date-time"
},
"source": {
"type": "string",
"enum": [
"advertiser",
"publisher"
]
},
"note": {
"type": "string"
},
"filename": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"deleted"
]
},
"file_size": {
"description": "file size in bytes",
"type": "integer"
},
"download_url": {
"description": "download url valid for 7 days from issue date",
"type": "string"
}
},
"type": "object"
},
"transaction_batch_aggregated_result": {
"properties": {
"status": {
"type": "string"
},
"count": {
"type": "integer"
},
"publisher_commission": {
"type": "number",
"format": "float"
},
"revenue": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"transaction_batch_job": {
"properties": {
"id": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"program_id": {
"type": "integer"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time"
},
"error_count": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"checked",
"done",
"failed",
"pending",
"running"
]
},
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_batch_aggregated_result"
}
}
},
"type": "object"
},
"transaction_batch_job_add": {
"required": [
"program_id",
"transactions"
],
"properties": {
"program_id": {
"type": "integer"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_batch_transaction"
}
}
},
"type": "object"
},
"transaction_batch_record_result": {
"properties": {
"success": {
"type": "boolean"
},
"error_field": {
"type": "string"
},
"error_message": {
"type": "string"
}
},
"type": "object"
},
"transaction_batch_result": {
"properties": {
"recordType": {
"type": "string",
"enum": [
"json"
]
},
"record": {
"type": "object"
},
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_batch_record_result"
}
}
},
"type": "object"
},
"transaction_batch_transaction": {
"required": [
"affiliatemarketing_id",
"part_id"
],
"properties": {
"affiliatemarketing_id": {
"type": "string"
},
"part_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
},
"publisher_commission": {
"type": "number",
"format": "float"
},
"revenue": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"transaction_v2_advertiser": {
"properties": {
"affiliatemarketing_id": {
"type": "string"
},
"transaction_id": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"program_id": {
"type": "integer"
},
"program_name": {
"type": "string"
},
"part_count": {
"type": "integer"
},
"commission": {
"type": "number",
"nullable": true
},
"program_commission": {
"type": "number"
},
"revenue": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"type": {
"type": "string",
"enum": [
"manual_advertiser",
"manual_publisher",
"normal"
]
},
"media_count": {
"type": "integer",
"nullable": true
},
"media_id": {
"type": "integer",
"nullable": true
},
"media_name": {
"type": "string",
"nullable": true
},
"media_type_id": {
"type": "integer",
"nullable": true
},
"media_location": {
"type": "string",
"nullable": true
},
"conversion_pixel": {
"type": "string",
"nullable": true
},
"anonymous_ip": {
"type": "string"
},
"ip_country_code": {
"type": "string"
},
"ip_hash": {
"type": "string"
},
"promotion_code": {
"type": "string"
},
"device_type_id": {
"type": "integer"
},
"device_model_id": {
"type": "integer"
},
"device_platform_id": {
"type": "integer"
},
"device_browser_id": {
"type": "integer"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
},
"transaction_v2_advertiser_part": {
"properties": {
"id": {
"type": "string"
},
"ad_id": {
"type": "integer"
},
"media_id": {
"type": "integer"
},
"media_name": {
"type": "string"
},
"media_type_id": {
"type": "integer"
},
"publisher_id": {
"type": "integer"
},
"publisher_name": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"date_click": {
"type": "string",
"format": "date-time"
},
"referer_click": {
"type": "string"
},
"compensation_code": {
"type": "string"
},
"commission": {
"type": "number"
},
"program_commission": {
"type": "number"
},
"revenue": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"program_description": {
"type": "string"
},
"publisher_description": {
"type": "string"
},
"extra_1": {
"type": "string"
},
"extra_2": {
"type": "string"
},
"extra_3": {
"type": "string"
},
"extra_4": {
"type": "string"
},
"extra_5": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"assist",
"compensation_upgrade",
"conversion_attribution",
"product"
]
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"approval_date": {
"type": "string",
"format": "date-time"
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
},
"invoice_number": {
"type": "string"
},
"invoice_status": {
"type": "string",
"enum": [
"cancelled",
"fraud",
"incasso",
"invoice",
"paid",
"pending"
]
},
"comment": {
"type": "string"
},
"modified_name": {
"type": "string"
},
"modified_username": {
"type": "string"
},
"modified_date": {
"type": "string",
"format": "date-time"
},
"initial_commission": {
"type": "number"
}
},
"type": "object"
},
"transaction_v2_advertiser_raw": {
"properties": {
"affiliatemarketing_id": {
"type": "string"
},
"transaction_id": {
"type": "string"
},
"part_id": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"ad_id": {
"type": "integer"
},
"media_id": {
"type": "integer"
},
"publisher_id": {
"type": "integer"
},
"date": {
"type": "string",
"format": "date-time"
},
"date_click": {
"type": "string",
"format": "date-time"
},
"referer_click": {
"type": "string"
},
"publisher_commission": {
"type": "number"
},
"program_commission": {
"type": "number"
},
"compensation_code": {
"type": "string"
},
"revenue": {
"type": "number"
},
"program_description": {
"type": "string"
},
"publisher_description": {
"type": "string"
},
"extra_1": {
"type": "string"
},
"extra_2": {
"type": "string"
},
"extra_3": {
"type": "string"
},
"extra_4": {
"type": "string"
},
"extra_5": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"assist",
"compensation_upgrade",
"conversion_attribution",
"product"
]
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"approval_date": {
"type": "string",
"format": "date-time"
},
"disapproved_reason": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
},
"modified_date": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"transaction_v2_advertiser_summary": {
"properties": {
"month": {
"type": "integer"
},
"year": {
"type": "integer"
},
"totals_by_status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transaction_v2_advertiser_summary_totals_by_status"
}
}
},
"type": "object"
},
"transaction_v2_advertiser_summary_totals_by_status": {
"properties": {
"transaction_count": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
},
"commission": {
"type": "number"
},
"program_commission": {
"type": "number"
},
"revenue": {
"type": "number"
},
"currency_code": {
"type": "string"
}
},
"type": "object"
},
"user_access_add": {
"required": [
"username"
],
"properties": {
"username": {
"type": "string",
"format": "email"
}
},
"type": "object"
},
"user_newsletters": {
"properties": {
"newsletters": {
"type": "array",
"items": {
"type": "string",
"enum": [
"advertiser_notifications",
"daily",
"general",
"notifications",
"specials",
"statistics",
"transactions",
"weekly"
]
}
},
"product_newsletters": {
"type": "array",
"items": {
"type": "string",
"enum": [
"advertiser_notifications",
"daily",
"general",
"notifications",
"specials",
"statistics",
"transactions",
"weekly"
]
}
},
"locale_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"user_permission_update": {
"properties": {
"permission": {
"type": "integer"
}
},
"type": "object"
},
"user_profile": {
"required": [
"username"
],
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"gender": {
"type": "string",
"enum": [
"female",
"male",
"unknown"
]
},
"birthday": {
"type": "string",
"format": "date"
},
"phonenumber": {
"$ref": "#/components/schemas/user_profile_phonenumber"
},
"profile_image": {
"description": "full https uri to a profile image, type jpg or png",
"type": "string"
},
"lastlogin_date": {
"type": "string",
"format": "date-time"
},
"lastlogin_ip": {
"type": "integer"
},
"language": {
"type": "string",
"enum": [
"da",
"de",
"en",
"es",
"fi",
"fr",
"nl",
"no",
"sv"
]
},
"country_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"newsletters": {
"type": "array",
"items": {
"type": "string",
"enum": [
"advertiser_notifications",
"daily",
"general",
"notifications",
"specials",
"statistics",
"transactions",
"weekly"
]
}
},
"locale_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"external_profiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/external_profile"
}
}
},
"type": "object"
},
"user_profile_permission": {
"required": [
"country_id",
"id",
"language",
"username"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_profile"
},
{
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"gender": {
"type": "string",
"enum": [
"female",
"male",
"unknown"
]
},
"birthday": {
"type": "string",
"format": "date"
},
"phonenumber": {
"$ref": "#/components/schemas/user_profile_phonenumber"
},
"profile_image": {
"type": "string"
},
"lastlogin_date": {
"type": "string",
"format": "date-time"
},
"lastlogin_ip": {
"type": "integer"
},
"external_profiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/external_profile"
}
},
"newsletters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/user_newsletters"
}
},
"language": {
"type": "string",
"enum": [
"da",
"de",
"en",
"es",
"fi",
"fr",
"nl",
"no",
"sv"
]
},
"country_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"permission": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"approved",
"pending"
]
}
},
"type": "object"
}
]
},
"user_profile_phonenumber": {
"required": [
"country_id",
"number",
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"home",
"mobile",
"work"
]
},
"country_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"number": {
"type": "string"
}
},
"type": "object"
},
"program_commission_advertiser": {
"properties": {
"default": {
"$ref": "#/components/schemas/program_commission_default_group_advertiser"
},
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_commission_group_advertiser"
}
},
"settings": {
"$ref": "#/components/schemas/program_commission_settings_advertiser"
}
},
"type": "object"
},
"program_commission_cost_per_click_advertiser": {
"properties": {
"amount": {
"description": "Response model for the cost per click of an advertiser custom commission group",
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_network_commission_advertiser"
}
},
"type": "object"
},
"program_commission_custom_group_delete": {
"properties": {
"apply_at": {
"description": "Optional scheduled date/time to apply the change",
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
},
"program_commission_custom_group_update": {
"properties": {
"name": {
"description": "Name of the custom group, must be unique per program",
"type": "string"
},
"cpc": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_cost_per_click_update"
}
],
"nullable": true,
"description": "Cost per click, set to 'null' to disable"
},
"tiering": {
"$ref": "#/components/schemas/program_commission_tiering_update"
},
"start": {
"description": "Apply the commission only after this date, set to 'null to disable",
"type": "string",
"format": "date",
"nullable": true
},
"end": {
"description": "Apply the commission only before this date, set to 'null' to disable",
"type": "string",
"format": "date",
"nullable": true
},
"priority": {
"description": "The priority for this group, should be between one and the number of groups",
"type": "integer"
},
"commission": {
"$ref": "#/components/schemas/program_commission_custom_group_commission_rows_update"
},
"media_group_id": {
"description": "The media group to apply the commission rates on",
"type": "integer"
},
"hidden": {
"description": "Set the group 'hidden' for publishers. Works in conjuction with status,if set to 'true' thestatus will become active",
"type": "boolean"
},
"status": {
"description": "Inactive commission are not processed",
"type": "string",
"enum": [
"active",
"inactive"
]
},
"apply_at": {
"description": "Scheduled date/time to apply the change",
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
},
"program_commission_default_group_advertiser": {
"properties": {
"id": {
"description": "Response model for the advertiser default commission group",
"type": "integer"
},
"name": {
"type": "string"
},
"cpc": {
"$ref": "#/components/schemas/program_commission_default_group_cost_per_click_advertiser"
},
"commission": {
"$ref": "#/components/schemas/program_commission_rows_advertiser"
},
"media_group_id": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"program_commission_default_group_cost_per_click_advertiser": {
"properties": {
"amount": {
"description": "Response model for the cost per click of the advertiser default commission group",
"type": "number",
"format": "float",
"nullable": true
},
"network": {
"$ref": "#/components/schemas/program_commission_network_commission_advertiser"
}
},
"type": "object"
},
"program_commission_display_commission_advertiser": {
"properties": {
"percentage": {
"description": "Response model for an advertiser display commission",
"type": "number",
"format": "float",
"nullable": true
},
"amount": {
"type": "number",
"format": "float",
"nullable": true
}
},
"type": "object"
},
"program_commission_group_advertiser": {
"properties": {
"id": {
"description": "Response model for an advertiser custom commission group",
"type": "integer"
},
"name": {
"type": "string"
},
"tiering": {
"$ref": "#/components/schemas/program_commission_tiering_advertiser"
},
"cpc": {
"$ref": "#/components/schemas/program_commission_cost_per_click_advertiser"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"priority": {
"type": "string"
},
"commission": {
"$ref": "#/components/schemas/program_commission_rows_advertiser"
},
"media_group_id": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"program_commission_network_commission_advertiser": {
"properties": {
"type": {
"description": "Response model for an advertiser network commission",
"type": "string",
"enum": [
"added_transaction_fee",
"fixed_ratio",
"margin",
"percentage",
"transaction_fee"
]
},
"value": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"program_commission_row_advertiser": {
"properties": {
"id": {
"description": "Response model for an advertiser commission row",
"type": "integer"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"type": {
"type": "string"
},
"percentage": {
"type": "number",
"format": "float"
},
"threshold": {
"type": "number",
"format": "float"
},
"ceiling": {
"type": "number",
"format": "float"
},
"amount": {
"type": "number",
"format": "float"
},
"network": {
"$ref": "#/components/schemas/program_commission_network_commission_advertiser"
},
"display_commission": {
"oneOf": [
{
"$ref": "#/components/schemas/program_commission_display_commission_advertiser"
}
],
"nullable": true,
"description": "Only set when a display commission is configured"
},
"hidden": {
"description": "Note: works in conjuction with status, if set to to true the status will be active",
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"type": "object"
},
"program_commission_rows_advertiser": {
"properties": {
"default": {
"$ref": "#/components/schemas/program_commission_row_advertiser"
},
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/program_commission_row_advertiser"
}
}
},
"type": "object"
},
"program_commission_settings_advertiser": {
"properties": {
"commission_code_field": {
"description": "Response model for the advertiser program commission settings",
"type": "string",
"enum": [
"adgroup_id",
"extra_1",
"extra_2",
"extra_3",
"extra_4",
"extra_5",
"program_description",
"publisher_description"
]
}
},
"type": "object"
},
"program_commission_tiering_advertiser": {
"required": [
"metric",
"scope"
],
"properties": {
"scope": {
"description": "Response model for the tiering settings of an advertiser custom commission group",
"type": "string",
"enum": [
"media",
"publisher"
]
},
"metric": {
"type": "string",
"enum": [
"count",
"publisher_commission"
]
}
},
"type": "object"
},
"program_commission_tiering_update": {
"properties": {
"scope": {
"description": "What the tiers are counted over, cannot be set to 'null'",
"type": "string",
"enum": [
"media",
"publisher"
]
},
"metric": {
"description": "What is counted to determine the tier, cannot be set to 'null'",
"type": "string",
"enum": [
"count",
"publisher_commission"
]
}
},
"type": "object"
},
"program_create": {
"required": [
"currency_code",
"default_locale_id",
"name",
"url"
],
"properties": {
"name": {
"description": "Request DTO for creating a program",
"type": "string"
},
"type": {
"type": "string",
"default": "affiliatemarketing",
"enum": [
"affiliatemarketing",
"leadgeneration",
"subnetwork"
]
},
"url": {
"type": "string"
},
"default_locale_id": {
"type": "string"
},
"currency_code": {
"description": "ISO 4217",
"type": "string"
}
},
"type": "object"
},
"change_proposal_advertiser_list": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/change_proposal_list"
},
{
"properties": {
"results": {
"description": "API list model for change proposals (advertiser view)",
"type": "array",
"items": {
"$ref": "#/components/schemas/change_proposal_advertiser"
}
}
},
"type": "object"
}
]
},
"change_proposal_advertiser": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/change_proposal"
},
{
"properties": {
"id": {
"description": "Unique identifier (UUID)",
"type": "string",
"format": "uuid"
},
"type": {
"description": "Type of change",
"type": "string"
},
"aggregate_id": {
"description": "Identifier of the aggregate being changed",
"type": "string"
},
"aggregate_type_name": {
"description": "Type name of the aggregate being changed",
"type": "string"
},
"apply_at": {
"description": "Scheduled date/time to apply the change",
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"description": "Timestamp when the proposal was created",
"type": "string",
"format": "date-time"
},
"created_by_name": {
"description": "User who created the proposal",
"type": "string"
},
"created_by_username": {
"description": "Username who created the proposal",
"type": "string"
},
"modified_at": {
"description": "Timestamp when the proposal was modified",
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_by_name": {
"description": "User who modified the proposal",
"type": "string",
"nullable": true
},
"modified_by_username": {
"description": "Username who modified the proposal",
"type": "string",
"nullable": true
},
"approval_status": {
"description": "Current approval status",
"type": "string",
"enum": [
"pending",
"approved",
"rejected",
"applied",
"canceled"
]
},
"approved_at": {
"description": "Timestamp when the proposal was approved/rejected",
"type": "string",
"format": "date-time",
"nullable": true
},
"approved_by_name": {
"description": "User who approved/rejected the proposal",
"type": "string",
"nullable": true
},
"approved_by_username": {
"description": "Username who approved/rejected the proposal",
"type": "string",
"nullable": true
},
"cancel_reason": {
"description": "Reason for cancellation, if applicable.",
"type": "string",
"nullable": true
},
"rejection_reason": {
"description": "Reason for rejection, if applicable.",
"type": "string",
"nullable": true
},
"diff": {
"description": "Changes between current and proposed state",
"type": "object",
"nullable": true
},
"preview": {
"description": "Full structure with proposed changes applied",
"type": "object",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
}
]
},
"change_proposal_list": {
"properties": {
"results": {
"description": "API list model for change proposals (admin view)",
"type": "array",
"items": {
"$ref": "#/components/schemas/change_proposal"
}
}
},
"type": "object"
},
"change_proposal": {
"properties": {
"id": {
"description": "Unique identifier (UUID)",
"type": "string",
"format": "uuid"
},
"type": {
"description": "Type of change",
"type": "string"
},
"tenant_type": {
"description": "Account type that owns this proposal (e.g. advertiser, publisher)",
"type": "string"
},
"tenant_id": {
"description": "Account identifier that owns this proposal",
"type": "string"
},
"aggregate_id": {
"description": "Identifier of the aggregate being changed",
"type": "string"
},
"aggregate_type_name": {
"description": "Type name of the aggregate being changed",
"type": "string"
},
"apply_at": {
"description": "Scheduled date/time to apply the change",
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"description": "Timestamp when the proposal was created",
"type": "string",
"format": "date-time"
},
"created_by_name": {
"description": "User who created the proposal",
"type": "string"
},
"created_by_username": {
"description": "Username who created the proposal",
"type": "string"
},
"modified_at": {
"description": "Timestamp when the proposal was modified",
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_by_name": {
"description": "User who modified the proposal",
"type": "string",
"nullable": true
},
"modified_by_username": {
"description": "Username who modified the proposal",
"type": "string",
"nullable": true
},
"approval_status": {
"description": "Current approval status",
"type": "string",
"enum": [
"pending",
"approved",
"rejected",
"applied",
"canceled"
]
},
"approved_at": {
"description": "Timestamp when the proposal was approved/rejected",
"type": "string",
"format": "date-time",
"nullable": true
},
"approved_by_name": {
"description": "User who approved/rejected the proposal",
"type": "string",
"nullable": true
},
"approved_by_username": {
"description": "Username who approved/rejected the proposal",
"type": "string",
"nullable": true
},
"cancel_reason": {
"description": "Reason for cancellation, if applicable.",
"type": "string",
"nullable": true
},
"rejection_reason": {
"description": "Reason for rejection, if applicable.",
"type": "string",
"nullable": true
},
"diff": {
"description": "Changes between current and proposed state",
"type": "object",
"nullable": true
},
"preview": {
"description": "Full structure with proposed changes applied",
"type": "object",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/link"
}
}
},
"type": "object"
}
},
"responses": {
"502": {
"description": "bad gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"400": {
"description": "bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"409": {
"description": "conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"403": {
"description": "forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"500": {
"description": "internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"204": {
"description": "no content"
},
"405": {
"description": "method not allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"404": {
"description": "not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"423": {
"description": "resource locked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"503": {
"description": "service unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"422": {
"description": "unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
}
},
"parameters": {
"ad_group_id": {
"name": "ad_group_id",
"in": "path",
"description": "Ad group ID",
"required": true,
"schema": {
"type": "integer"
}
},
"ad_id": {
"name": "ad_id",
"in": "path",
"description": "Ad ID",
"required": true,
"schema": {
"type": "integer"
}
},
"advertiser_id": {
"name": "advertiser_id",
"in": "path",
"description": "Advertiser ID",
"required": true,
"schema": {
"type": "integer"
}
},
"advertiser_invoice_number": {
"name": "invoice_number",
"in": "query",
"description": "Invoice Number",
"required": false,
"schema": {
"type": "integer"
}
},
"affiliatemarketing_id": {
"name": "affiliatemarketing_id",
"in": "path",
"description": "Affiliatemarketing ID",
"required": true,
"schema": {
"type": "string"
}
},
"agreement_terms_id": {
"name": "agreement_terms_id",
"in": "path",
"description": "Agreement terms ID",
"required": true,
"schema": {
"type": "string"
}
},
"app_id": {
"name": "app_id",
"in": "path",
"description": "App ID",
"required": true,
"schema": {
"type": "integer"
}
},
"attachment_id": {
"name": "attachment_id",
"in": "path",
"description": "attachment ID",
"required": true,
"schema": {
"type": "integer"
}
},
"commission_group_id": {
"name": "commission_group_id",
"in": "path",
"description": "Custom Group ID",
"required": true,
"schema": {
"type": "integer"
}
},
"currency_code": {
"name": "currency_code",
"in": "query",
"description": "Currency code (ISO 4217), comma separated",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
"custom_domain_id": {
"name": "custom_domain_id",
"in": "path",
"description": "Custom domain ID",
"required": true,
"schema": {
"type": "string"
}
},
"custom_domain_status": {
"name": "status",
"in": "path",
"description": "Custom domain status (JSON filter allowed)",
"required": true,
"schema": {
"type": "string",
"enum": [
"deleted",
"initializing",
"pending_deletion",
"pending_registration",
"pending_verification",
"registered",
"verified"
]
}
},
"dateselection_end": {
"name": "end",
"in": "query",
"description": "End date (YYYY-MM-DD)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"dateselection_start": {
"name": "start",
"in": "query",
"description": "Start date (YYYY-MM-DD)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"deeplink_id": {
"name": "deeplink_id",
"in": "path",
"description": "Deeplink ID",
"required": true,
"schema": {
"type": "integer"
}
},
"delivery_id": {
"name": "delivery_id",
"in": "path",
"description": "Delivery ID",
"required": true,
"schema": {
"type": "integer"
}
},
"description_id": {
"name": "description_id",
"in": "path",
"description": "Description ID",
"required": true,
"schema": {
"type": "integer"
}
},
"distribution_group_id": {
"name": "distribution_group_id",
"in": "path",
"description": "Distribution group ID",
"required": true,
"schema": {
"type": "integer"
}
},
"email_hash": {
"name": "hash",
"in": "path",
"description": "MD5 hash of email",
"required": true,
"schema": {
"type": "string"
}
},
"filename": {
"name": "filename",
"in": "path",
"description": "Ad attachment filename",
"required": true,
"schema": {
"type": "string"
}
},
"filter_account_name": {
"name": "account_name",
"in": "query",
"description": "Account name",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_ad_adgroup_id": {
"name": "ad_adgroup_id",
"in": "query",
"description": "Ad adgroup IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_ad_dimension": {
"name": "dimension",
"in": "query",
"description": "Ad dimensions format: 'WIDTHxHEIGHT' eg 468x60",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_ad_group_id": {
"name": "ad_group_id",
"in": "query",
"description": "Ad group IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_ad_group_status": {
"name": "status",
"in": "query",
"description": "Ad group status",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": "",
"enum": [
"active",
"inactive"
]
}
},
"filter_ad_id": {
"name": "ad_id",
"in": "query",
"description": "Ad IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_ad_impressions": {
"name": "ad_impressions",
"in": "query",
"description": "Ad impressions (json: gt, lt, e.g. {\"gt\": 1000, \"lt\": 50000})",
"required": false,
"schema": {
"type": "string"
}
},
"filter_ad_type": {
"name": "type",
"in": "query",
"description": "Mime type ('image/jpeg', 'image/jpg', 'image/png', 'image/gif', 'text/html','text/plain')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"image/gif",
"image/jpeg",
"image/jpg",
"image/png",
"text/html",
"text/plain"
]
}
},
"filter_ad_type_2": {
"name": "ad_type",
"in": "query",
"description": "Ad type ('banner', 'textlink', 'html')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"banner",
"html",
"textlink"
]
}
},
"filter_adgroup_id": {
"name": "adgroup_id",
"in": "query",
"description": "Adgroup IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_advertiser_invoice_reference_number": {
"name": "invoice_reference_number",
"in": "query",
"description": "Invoice reference number",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_advertiser_invoice_status": {
"name": "invoice_status",
"in": "query",
"description": "Invoice status (if omitted, all values will be used)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": "",
"enum": [
"paid",
"pending"
]
}
},
"filter_advertiser_media_subscription_auto_approval_date": {
"name": "auto_approval_date",
"in": "query",
"description": "Auto approval date (when used, results will be limited to this date and before)",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_advertiser_media_subscription_status": {
"name": "subscription_status",
"in": "query",
"description": "Subscription status ('none', 'open', 'approved', 'disapproved', 'hidden', 'invited')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"approved",
"disapproved",
"hidden",
"invited",
"none",
"open"
]
}
},
"filter_advertiser_notification_source": {
"name": "source",
"in": "query",
"description": "Source",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"system"
]
}
},
"filter_advertiser_product_feed_file_type": {
"name": "file_type",
"in": "query",
"description": "File type",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api",
"csv",
"xml"
]
}
}
},
"filter_advertiser_product_feed_status": {
"name": "status",
"in": "query",
"description": "Status",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"active",
"pending",
"rejected"
]
}
}
},
"filter_advertiser_program_status": {
"name": "status",
"in": "query",
"description": "Status ('active', 'archived', 'deverted', 'pending', 'cooldown')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"active",
"archived",
"cooldown",
"deverted",
"pending"
]
}
},
"filter_advertiser_subscription_status": {
"name": "status",
"in": "query",
"description": "Subscription status ('open', 'approved', 'disapproved', 'hidden', 'invited')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"approved",
"disapproved",
"hidden",
"invited",
"open"
]
}
},
"filter_advertiser_transaction_invoice_status": {
"name": "invoice_status",
"in": "query",
"description": "Invoice status (supported value: paid)",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "string",
"enum": [
"paid"
]
}
},
"filter_affiliatemarketing_id": {
"name": "affiliatemarketing_id",
"in": "query",
"description": "Affiliatemarketing IDs",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_agreement_terms_date": {
"name": "agreement_terms_date",
"in": "query",
"description": "Date (YYYY-MM-DD)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
"filter_agreement_terms_id": {
"name": "agreement_terms_id",
"in": "query",
"description": "Agreement terms ID",
"required": false,
"schema": {
"type": "integer"
}
},
"filter_all_open_transactions": {
"name": "all_open_transactions",
"in": "query",
"description": "All open transactions",
"required": false,
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"filter_allowed_media_type_id": {
"name": "allowed_media_type_id",
"in": "query",
"description": "Allowed media type ID",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"filter_approval_date_end": {
"name": "date_approval_end",
"in": "query",
"description": "Approval date end (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_approval_date_start": {
"name": "date_approval_start",
"in": "query",
"description": "Approval date (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_approval_request_date_end": {
"name": "approval_request_date_end",
"in": "query",
"description": "End approval request date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_approval_request_date_start": {
"name": "approval_request_date_start",
"in": "query",
"description": "Start approval request date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_apps_connected_status": {
"name": "status",
"in": "query",
"description": "Status ('active', 'deleted')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": "active",
"enum": [
"active",
"deleted"
]
}
},
"filter_block_ip_from": {
"name": "from_ip",
"in": "query",
"description": "From IP address",
"required": false,
"schema": {
"type": "string"
}
},
"filter_block_ip_to": {
"name": "to_ip",
"in": "query",
"description": "To IP address",
"required": false,
"schema": {
"type": "string"
}
},
"filter_block_name": {
"name": "name",
"in": "query",
"description": "Name of the IP block (wildcards * allowed)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_block_status": {
"name": "status",
"in": "query",
"description": "Status of the IP block",
"required": false,
"schema": {
"type": "string",
"enum": [
"allow",
"deny"
]
}
},
"filter_by_annual_event_id": {
"name": "annual_event_id",
"in": "query",
"description": "Annual Event ID",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_category_id": {
"name": "category_id",
"in": "query",
"description": "Category IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_click_date_end": {
"name": "date_click_end",
"in": "query",
"description": "Click date end (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_click_date_start": {
"name": "date_click_start",
"in": "query",
"description": "Click date (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_click_type": {
"name": "type",
"in": "query",
"description": "Click types ('cpc', 'click')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"click",
"cpc"
]
}
},
"filter_content": {
"name": "content",
"in": "query",
"description": "Content (wildcards * allowed)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_conversion_rate": {
"name": "conversion_rate",
"in": "query",
"description": "Conversion rate (json: gt, lt, e.g. {\"gt\": 0.1, \"lt\": 0.5})",
"required": false,
"schema": {
"type": "string"
}
},
"filter_country_code": {
"name": "country_code",
"in": "query",
"description": "Country code",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_country_id": {
"name": "country_id",
"in": "query",
"description": "Country IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_creation_date_end": {
"name": "creation_date_end",
"in": "query",
"description": "Creation end date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_creation_date_start": {
"name": "creation_date_start",
"in": "query",
"description": "Creation start date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_ctr": {
"name": "ctr",
"in": "query",
"description": "Clickthrough rate (json: gt, lt, e.g. {\"gt\": 0.01, \"lt\": 0.1})",
"required": false,
"schema": {
"type": "string"
}
},
"filter_currency_code": {
"name": "currency_code",
"in": "query",
"description": "Currency codes (ISO 4217), comma separated",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_currency_codes": {
"name": "currency_code",
"in": "query",
"description": "Currency codes (ISO 4217)",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"filter_datafeed_compression_type": {
"name": "compression_type",
"in": "query",
"description": "Compression type",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"gz",
"zip"
]
}
}
},
"filter_date_end": {
"name": "end",
"in": "query",
"description": "End date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_date_end_required": {
"name": "date_end",
"in": "query",
"description": "End date (YYYY-MM-DD HH:II:SS)",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_date_out_end": {
"name": "date_out_end",
"in": "query",
"description": "End date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_date_out_start": {
"name": "date_out_start",
"in": "query",
"description": "Start date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_date_start": {
"name": "start",
"in": "query",
"description": "Start date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_date_start_required": {
"name": "date_start",
"in": "query",
"description": "Start date (YYYY-MM-DD HH:II:SS)",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_dedicated_media_id": {
"name": "media_id",
"in": "query",
"description": "Dedicated media ID",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_delivery_id": {
"name": "delivery_id",
"in": "query",
"description": "Delivery ID",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_description": {
"name": "description",
"in": "query",
"description": "Description (wildcards * allowed)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_description_id": {
"name": "description_id",
"in": "query",
"description": "Description ID",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_device_browser_brand": {
"name": "device_browser_brand",
"in": "query",
"description": "Device browser brands",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_device_browser_id": {
"name": "device_browser_id",
"in": "query",
"description": "Device browser IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_device_model_id": {
"name": "device_model_id",
"in": "query",
"description": "Device model IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_device_platform_brand": {
"name": "device_platform_brand",
"in": "query",
"description": "Device platform brands",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_device_platform_id": {
"name": "device_platform_id",
"in": "query",
"description": "Device platform IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_device_type_id": {
"name": "device_type_id",
"in": "query",
"description": "Device type ID",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_ecpc": {
"name": "ecpc",
"in": "query",
"description": "Effective cost per click (json: gt, lt, e.g. {\"gt\": 0.05, \"lt\": 2.00})",
"required": false,
"schema": {
"type": "string"
}
},
"filter_email_hash": {
"name": "hash",
"in": "query",
"description": "MD5 hash of email",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_emails": {
"name": "emails",
"in": "query",
"description": "Emails",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_end_date": {
"name": "end_date",
"in": "query",
"description": "End date (YYYY-MM-DD)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
"filter_end_date_json": {
"name": "end_date",
"in": "query",
"description": "End date (json: eq, ne, gt, gte, lt, lte)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_enddate_end": {
"name": "enddate_end",
"in": "query",
"description": "End enddate (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_enddate_start": {
"name": "enddate_start",
"in": "query",
"description": "Begin enddate (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_finance_advertiser_invoice_number": {
"name": "invoice_number",
"in": "query",
"description": "Invoice number(s), comma separated",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_finance_advertiser_invoice_order": {
"name": "order",
"in": "query",
"description": "Order by",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": "date",
"enum": [
"date",
"date_due",
"invoice_number"
]
}
},
"filter_finance_advertiser_invoice_status": {
"name": "status",
"in": "query",
"description": "Invoice statuse(s), comma separated",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"incasso",
"invoice",
"paid"
]
}
},
"filter_google_account": {
"name": "google_account",
"in": "query",
"description": "Google account (e-mail)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_google_permission": {
"name": "google_permission",
"in": "query",
"description": "Google service permission",
"required": false,
"schema": {
"type": "string",
"enum": [
"denied",
"granted"
]
}
},
"filter_google_service": {
"name": "google_service",
"in": "query",
"description": "Google service",
"required": false,
"schema": {
"type": "string",
"enum": [
"analytics"
]
}
},
"filter_has_last_modified_header": {
"name": "has_last_modified_header",
"in": "query",
"description": "Has last modified header",
"required": false,
"schema": {
"type": "boolean"
}
},
"filter_ip_country_code": {
"name": "ip_country_code",
"in": "query",
"description": "Country code",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_ip_hash": {
"name": "ip_hash",
"in": "query",
"description": "IP hash",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_ip_region_code": {
"name": "ip_region_code",
"in": "query",
"description": "Region code",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_is_dedicated": {
"name": "is_dedicated",
"in": "query",
"description": "Is dedicated",
"required": false,
"schema": {
"type": "boolean"
}
},
"filter_keywords": {
"name": "keywords",
"in": "query",
"description": "Search based on one or more keywords",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
},
"filter_language_code": {
"name": "language_code",
"in": "query",
"description": "Language code",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_language_code_required": {
"name": "language_code",
"in": "query",
"description": "Language code",
"required": true,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_language_codes": {
"name": "language_code",
"in": "query",
"description": "Language codes",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"filter_language_id": {
"name": "language_id",
"in": "query",
"description": "Language ID",
"required": false,
"schema": {
"type": "integer"
}
},
"filter_language_ids": {
"name": "language_id",
"in": "query",
"description": "Language IDs",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_lead_description": {
"name": "description",
"in": "query",
"description": "Lead description",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_lead_id": {
"name": "lead_id",
"in": "query",
"description": "Lead IDs",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_lead_status": {
"name": "status",
"in": "query",
"description": "Status ('approved', 'disapproved', 'open')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
}
},
"filter_locale_id": {
"name": "locale_id",
"in": "query",
"description": "Locale IDs",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_mailing_approval_type": {
"name": "type",
"in": "query",
"description": "Mailing approval type",
"required": false,
"schema": {
"type": "string",
"enum": [
"email",
"screenshot",
"url"
]
}
},
"filter_mailing_approval_url": {
"name": "url",
"in": "query",
"description": "Mailing approval source url (wildcards * allowed)",
"required": false,
"schema": {
"type": "string",
"format": "string",
"default": ""
}
},
"filter_mailing_id": {
"name": "mailing_id",
"in": "query",
"description": "Mailing IDs",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
"filter_mailing_status": {
"name": "status",
"in": "query",
"description": "Status",
"required": false,
"schema": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
}
},
"filter_marketplace_highlighted": {
"name": "highlighted",
"in": "query",
"description": "Highlighted",
"required": false,
"schema": {
"type": "boolean"
}
},
"filter_marketplace_media_type_id": {
"name": "media_type_id",
"in": "query",
"description": "Media type ID",
"required": false,
"schema": {
"type": "integer"
}
},
"filter_marketplace_offer_id": {
"name": "offer_id",
"in": "query",
"description": "Offer Id",
"required": false,
"schema": {
"type": "integer"
}
},
"filter_marketplace_order_status": {
"name": "status",
"in": "query",
"description": "Status",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"accepted",
"confirmed",
"declined",
"delivered",
"pending_acceptance"
]
}
},
"filter_marketplace_price": {
"name": "price",
"in": "query",
"description": "Price (json: eq, ne, gt, gte, lt, lte, e.g. {\"gte\": 10.00, \"lte\": 100.00})",
"required": false,
"schema": {
"type": "string"
}
},
"filter_marketplace_type_id": {
"name": "type_id",
"in": "query",
"description": "Marketplace type ID",
"required": false,
"schema": {
"type": "integer"
}
},
"filter_material_ad_type": {
"name": "ad_type",
"in": "query",
"description": "Ad type ('text', 'image', 'html', 'remote')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"html",
"image",
"remote",
"text"
]
}
},
"filter_media_category_id": {
"name": "media_category_id",
"in": "query",
"description": "Media category IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_media_country_code": {
"name": "media_country_code",
"in": "query",
"description": "Media country code",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_media_filter_group_id": {
"name": "media_group_id",
"in": "query",
"description": "Media group IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_media_filter_id": {
"name": "media_filter_id",
"in": "query",
"description": "Media filter IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_media_group_id": {
"name": "media_group_id",
"in": "query",
"description": "Media group ID (json: eq, ne)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_media_group_id_collection": {
"name": "media_group_id",
"in": "query",
"description": "Media group IDs",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"filter_media_id": {
"name": "media_id",
"in": "query",
"description": "Media IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_media_invite_status": {
"name": "status",
"in": "query",
"description": "Invite status",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"accepted",
"canceled",
"declined",
"expired",
"invited"
]
}
},
"filter_media_language_code": {
"name": "media_language_code",
"in": "query",
"description": "Media language code",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_media_type_id": {
"name": "type_id",
"in": "query",
"description": "Media type ID",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_modified_date_end": {
"name": "date_modified_end",
"in": "query",
"description": "Last modification date end (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_modified_date_start": {
"name": "date_modified_start",
"in": "query",
"description": "Last modification date (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_name": {
"name": "name",
"in": "query",
"description": "Name (wildcards * allowed)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_news_id": {
"name": "id",
"in": "query",
"description": "News IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_news_search": {
"name": "search",
"in": "query",
"description": "Search based on keyword (wildcards * allowed)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_news_status": {
"name": "status",
"in": "query",
"description": "Status ('pending', 'public', 'deleted')",
"required": false,
"schema": {
"type": "string",
"enum": [
"deleted",
"pending",
"public"
]
}
},
"filter_news_subscribed": {
"name": "subscribed",
"in": "query",
"description": "Subscribed ('true', 'false')",
"required": false,
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"filter_news_type_advertiser": {
"name": "type",
"in": "query",
"description": "Status ('update','promotion','coupon')",
"required": false,
"schema": {
"type": "string",
"enum": [
"coupon",
"promotion",
"update"
]
}
},
"filter_newsletter": {
"name": "newsletter",
"in": "query",
"description": "Status ('daily', 'weekly')",
"required": false,
"schema": {
"type": "string",
"enum": [
"daily",
"weekly"
]
}
},
"filter_note": {
"name": "note",
"in": "query",
"description": "note (wildcards * allowed)",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_notification_date_end": {
"name": "end",
"in": "query",
"description": "End date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_notification_date_start": {
"name": "start",
"in": "query",
"description": "Start date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_notification_id": {
"name": "notification_id",
"in": "query",
"description": "Notification ID",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_notification_level": {
"name": "level",
"in": "query",
"description": "Level",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"major",
"minor",
"normal"
]
}
},
"filter_notification_recipient": {
"name": "recipient",
"in": "query",
"description": "Active, subscribed or selected publishers",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"active",
"selected",
"subscribed"
]
}
},
"filter_notification_status_advertiser": {
"name": "status",
"in": "query",
"description": "Status",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"pending",
"sent"
]
}
},
"filter_notification_status_advertiser_receive": {
"name": "status",
"in": "query",
"description": "Status",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"notified",
"read"
]
}
},
"filter_part_id": {
"name": "part_id",
"in": "query",
"description": "Parts IDs",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_part_status": {
"name": "part_status",
"in": "query",
"description": "Status ('approved', 'disapproved', 'open')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
}
},
"filter_part_type": {
"name": "part_type",
"in": "query",
"description": "Part type ('product', 'assist', 'compensation_upgrade', 'conversion_attribution')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"assist",
"compensation_upgrade",
"conversion_attribution",
"product"
]
}
},
"filter_partnership_management_access_rule_status": {
"name": "status",
"in": "query",
"description": "Filter status",
"required": false,
"schema": {
"type": "string",
"enum": [
"active",
"pending"
]
}
},
"filter_program_commission": {
"name": "program_commission",
"in": "query",
"description": "Program commission",
"required": false,
"schema": {
"type": "string"
}
},
"filter_program_deeplink": {
"name": "deeplink",
"in": "query",
"description": "Deeplink possible ('false', 'true')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"filter_program_description": {
"name": "program_description",
"in": "query",
"description": "Description (program)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_program_id": {
"name": "program_id",
"in": "query",
"description": "Program IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_program_id_json": {
"name": "program_id",
"in": "query",
"description": "Program IDs (json: eq, ne)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_program_id_required": {
"name": "program_id",
"in": "query",
"description": "Program ID",
"required": true,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_program_ids": {
"name": "program_id",
"in": "query",
"description": "Program IDs",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"filter_program_productfeed": {
"name": "productfeed",
"in": "query",
"description": "Product feed ('false', 'true')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"filter_program_publisher_tag": {
"name": "publisher_tag",
"in": "query",
"description": "Publisher tag ('false', 'true')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"filter_promotion_available_for": {
"name": "available_for",
"in": "query",
"description": "Filter by promotion availability",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": "",
"enum": [
"daisycon",
"everyone",
"specific_media"
]
}
},
"filter_promotion_available_for_media_id": {
"name": "available_for_media_id",
"in": "query",
"description": "Filter for media dedicated promotions",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_promotion_code": {
"name": "code",
"in": "query",
"description": "Filter by code (exact match)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_promotion_has_code": {
"name": "has_code",
"in": "query",
"description": "Filter by presence of code",
"required": false,
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"filter_promotion_status": {
"name": "status",
"in": "query",
"description": "Filter by status",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"active",
"inactive",
"pending"
]
}
},
"filter_promotion_type": {
"name": "type",
"in": "query",
"description": "Filter by type",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"amount",
"free_item",
"free_shipping",
"other",
"percentage",
"stack_discount"
]
}
},
"filter_promotioncode": {
"name": "promotioncode",
"in": "query",
"description": "Promotion code (wildcards * allowed)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_publisher_account_name": {
"name": "name",
"in": "query",
"description": "Publisher accountname(s)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_publisher_commission": {
"name": "publisher_commission",
"in": "query",
"description": "Publisher commission",
"required": false,
"schema": {
"type": "string"
}
},
"filter_publisher_description": {
"name": "publisher_description",
"in": "query",
"description": "Description",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_publisher_id": {
"name": "publisher_id",
"in": "query",
"description": "Publisher IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_publisher_name": {
"name": "publisher_name",
"in": "query",
"description": "Publisher name",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_questionnaire_id": {
"name": "questionnaire_id",
"in": "query",
"description": "Questionnaire ID",
"required": false,
"schema": {
"type": "integer"
}
},
"filter_reference": {
"name": "reference",
"in": "query",
"description": "Reference",
"required": false,
"schema": {
"type": "string"
}
},
"filter_requested_delivery_date_json": {
"name": "requested_delivery_date",
"in": "query",
"description": "Requested delivery date (json: eq, ne, gt, gte, lt, lte)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_revenue": {
"name": "revenue",
"in": "query",
"description": "Revenue",
"required": false,
"schema": {
"type": "number"
}
},
"filter_search_term": {
"name": "search_term",
"in": "query",
"description": "Search term (wildcard * is allowed)",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_search_term_no_wildcard": {
"name": "search_term",
"in": "query",
"description": "Search term",
"required": false,
"schema": {
"type": "string"
}
},
"filter_send_date_end": {
"name": "send_date_end",
"in": "query",
"description": "End send date (YYYY-MM-DD)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
"filter_send_date_start": {
"name": "send_date_start",
"in": "query",
"description": "Start send date (YYYY-MM-DD)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
"filter_send_datetime_end": {
"name": "send_datetime_end",
"in": "query",
"description": "End send date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_send_datetime_start": {
"name": "send_datetime_start",
"in": "query",
"description": "Start send date (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_sender": {
"name": "sender",
"in": "query",
"description": "Sender",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_sender_name": {
"name": "sender_name",
"in": "query",
"description": "Sender name",
"required": false,
"schema": {
"type": "string"
}
},
"filter_smartview": {
"name": "smartview",
"in": "query",
"description": "Smartview ('click', 'transaction'), By default transactions will be retrieved by start and enddate of the transaction, but with the Daisycon Smartview you can also select the transactions based on thestart and end date of the click belonging to the transaction.",
"required": false,
"schema": {
"type": "string",
"default": "transaction",
"enum": [
"click",
"transaction"
]
}
},
"filter_standard_id": {
"name": "standard_id",
"in": "query",
"description": "Standard IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_standard_id_required": {
"name": "standard_id",
"in": "query",
"description": "Standard ID",
"required": true,
"explode": false,
"schema": {
"type": "integer"
}
},
"filter_standard_ids": {
"name": "standard_id",
"in": "query",
"description": "Standard IDs",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"filter_start_date": {
"name": "start_date",
"in": "query",
"description": "Start date (YYYY-MM-DD)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
"filter_start_date_json": {
"name": "start_date",
"in": "query",
"description": "Start date (json: eq, ne, gt, gte, lt, lte)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_startdate_end": {
"name": "startdate_end",
"in": "query",
"description": "End startdate (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_startdate_start": {
"name": "startdate_start",
"in": "query",
"description": "Begin startdate (YYYY-MM-DD HH:II:SS)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_subject": {
"name": "subject",
"in": "query",
"description": "Subject",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_subscribe_approval_date": {
"name": "subscribe_approval_date",
"in": "query",
"description": "Subscription approval date time (json: gt, gte, lt, lte)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_subscribe_date": {
"name": "subscribe_date",
"in": "query",
"description": "Subscription date time (json: gt, gte, lt, lte)",
"required": false,
"schema": {
"type": "string"
}
},
"filter_subscribed": {
"name": "subscribed",
"in": "query",
"description": "Show offers based on the media subscription status",
"required": false,
"schema": {
"type": "boolean"
}
},
"filter_subscription_approval_date_end": {
"name": "date_approval_end",
"in": "query",
"description": "Approval date end (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_subscription_approval_date_start": {
"name": "date_approval_start",
"in": "query",
"description": "Approval date start (YYYY-MM-DD HH:II:SS)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
"filter_supply_locale_id": {
"name": "supply_locale_id",
"in": "query",
"description": "Supply locale IDs",
"required": false,
"explode": false,
"schema": {
"type": "string"
}
},
"filter_target_group": {
"name": "target_group",
"in": "query",
"description": "Target group",
"required": false,
"schema": {
"type": "string"
}
},
"filter_target_group_size": {
"name": "target_group_size",
"in": "query",
"description": "Target group size (json: gt, lt, e.g. {\"gt\": 100, \"lt\": 10000})",
"required": false,
"schema": {
"type": "string"
}
},
"filter_text": {
"name": "text",
"in": "query",
"description": "Text (wildcards * allowed)",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_ticket_status": {
"name": "status",
"in": "query",
"description": "Status ('open', 'solved', 'closed')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"closed",
"open",
"solved"
]
}
},
"filter_title": {
"name": "title",
"in": "query",
"description": "Title (wildcards * allowed)",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_transaction_batch_job_id": {
"name": "job_id",
"in": "query",
"description": "Transaction batch job ID",
"required": false,
"explode": false,
"schema": {
"type": "integer",
"default": ""
}
},
"filter_transaction_batch_result_success": {
"name": "success",
"in": "query",
"description": "All succesfull processed transaction batch records",
"required": false,
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
"filter_transaction_commission_end": {
"name": "transaction_commission_end",
"in": "query",
"description": "Transaction commission end",
"required": false,
"schema": {
"type": "number",
"default": ""
}
},
"filter_transaction_commission_start": {
"name": "transaction_commission_start",
"in": "query",
"description": "Transaction commission start",
"required": false,
"schema": {
"type": "number",
"default": ""
}
},
"filter_transaction_disapproved_reason": {
"name": "disapproved_reason",
"in": "query",
"description": "Disapproved reason ('invalid', 'duplicate', 'cancelled', 'nopayment', 'refunded','testorder')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"cancelled",
"duplicate",
"invalid",
"nopayment",
"refunded",
"testorder"
]
}
},
"filter_transaction_extra_1": {
"name": "extra_1",
"in": "query",
"description": "Extra 1",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_transaction_extra_2": {
"name": "extra_2",
"in": "query",
"description": "Extra 2",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_transaction_extra_3": {
"name": "extra_3",
"in": "query",
"description": "Extra 3",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_transaction_extra_4": {
"name": "extra_4",
"in": "query",
"description": "Extra 4",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_transaction_extra_5": {
"name": "extra_5",
"in": "query",
"description": "Extra 5",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_transaction_id": {
"name": "transaction_id",
"in": "query",
"description": "Transaction ID",
"required": false,
"explode": false,
"schema": {
"type": "string",
"default": ""
}
},
"filter_transaction_job_status": {
"name": "status",
"in": "query",
"description": "Status ('running', 'done', 'failed', 'checked', 'pending')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"checked",
"done",
"failed",
"pending",
"running"
]
}
},
"filter_transaction_raw_fields": {
"name": "fields",
"in": "query",
"description": "Comma separated fieldnames to return, when empty all fields are returned",
"required": false,
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ad_id",
"affiliatemarketing_id",
"approval_date",
"compensation_code",
"currency_code",
"date",
"date_click",
"disapproved_reason",
"extra_1",
"extra_2",
"extra_3",
"extra_4",
"extra_5",
"media_id",
"modified_date",
"part_id",
"program_commission",
"program_description",
"publisher_commission",
"publisher_description",
"publisher_id",
"quantity",
"referer_click",
"revenue",
"sku",
"status",
"transaction_id",
"type"
]
}
}
},
"filter_transaction_revenue_end": {
"name": "transaction_revenue_end",
"in": "query",
"description": "Transaction revenue end",
"required": false,
"schema": {
"type": "number",
"default": ""
}
},
"filter_transaction_revenue_start": {
"name": "transaction_revenue_start",
"in": "query",
"description": "Transaction revenue start",
"required": false,
"schema": {
"type": "number",
"default": ""
}
},
"filter_transaction_status": {
"name": "status",
"in": "query",
"description": "Status ('approved', 'disapproved', 'open')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"approved",
"disapproved",
"open"
]
}
},
"filter_transaction_type_v2": {
"name": "transaction_type",
"in": "query",
"description": "Transaction type ('normal', 'manual_advertiser', 'manual_publisher','revenue_share)",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"manual_advertiser",
"manual_publisher",
"normal",
"revenue_share"
]
}
},
"filter_used_compensation_code": {
"name": "used_compensation_code",
"in": "query",
"description": "Used compensation code",
"explode": false,
"schema": {
"type": "string"
}
},
"filter_user_connection_status": {
"name": "status",
"in": "query",
"description": "User connection status",
"required": false,
"schema": {
"type": "string",
"enum": [
"active",
"pending"
]
}
},
"filter_user_id": {
"name": "user_id",
"in": "query",
"description": "User IDs",
"required": false,
"explode": false,
"schema": {
"type": "integer"
}
},
"google_permission_id": {
"name": "google_permission_id",
"in": "path",
"description": "Google permission ID",
"required": true,
"schema": {
"type": "integer"
}
},
"history_id": {
"name": "history_id",
"in": "path",
"description": "History ID",
"required": true,
"schema": {
"type": "integer"
}
},
"invite_id": {
"name": "invite_id",
"in": "path",
"description": "Invite ID",
"required": true,
"schema": {
"type": "integer"
}
},
"invoice_number": {
"name": "invoice_number",
"in": "path",
"description": "Invoice number",
"required": true,
"schema": {
"type": "string"
}
},
"ip_block_id": {
"name": "ip_block_id",
"in": "path",
"description": "IP Block ID",
"required": true,
"schema": {
"type": "integer"
}
},
"job_id": {
"name": "job_id",
"in": "path",
"description": "Job ID",
"required": true,
"schema": {
"type": "integer"
}
},
"language_code": {
"name": "language_code",
"in": "path",
"description": "Language code",
"required": true,
"schema": {
"type": "string"
}
},
"list_id": {
"name": "list_id",
"in": "path",
"description": "List ID",
"required": true,
"schema": {
"type": "string"
}
},
"mailing_id": {
"name": "mailing_id",
"in": "path",
"description": "Mailing ID",
"required": true,
"schema": {
"type": "string"
}
},
"marketplace_offer_id": {
"name": "offer_id",
"in": "path",
"description": "Offer ID",
"required": true,
"schema": {
"type": "integer"
}
},
"marketplace_offer_variant_id": {
"name": "variant_id",
"in": "path",
"description": "Offer Variant ID",
"required": true,
"schema": {
"type": "integer"
}
},
"marketplace_order_id": {
"name": "order_id",
"in": "path",
"description": "Order ID",
"required": true,
"schema": {
"type": "integer"
}
},
"media_group_id": {
"name": "media_group_id",
"in": "path",
"description": "Media group ID",
"required": true,
"schema": {
"type": "integer"
}
},
"media_id": {
"name": "media_id",
"in": "path",
"description": "Media ID",
"required": true,
"schema": {
"type": "integer"
}
},
"media_kit_id": {
"name": "media_kit_id",
"in": "path",
"description": "Media kit ID",
"required": true,
"schema": {
"type": "integer"
}
},
"media_type_id": {
"name": "media_type_id",
"in": "path",
"description": "Media type ID",
"required": true,
"schema": {
"type": "integer"
}
},
"name": {
"name": "name",
"in": "path",
"description": "Name",
"required": true,
"schema": {
"type": "string"
}
},
"negative_keyword_id": {
"name": "negative_keyword_id",
"in": "path",
"description": "Negative keyword ID",
"required": true,
"schema": {
"type": "string"
}
},
"news_id": {
"name": "news_id",
"in": "path",
"description": "Newsitem ID",
"required": true,
"schema": {
"type": "integer"
}
},
"notification_id": {
"name": "notification_id",
"in": "path",
"description": "Notification ID",
"required": true,
"schema": {
"type": "integer"
}
},
"notification_template_id": {
"name": "notification_template_id",
"in": "path",
"description": "Notification template ID",
"required": true,
"schema": {
"type": "integer"
}
},
"order_by_advertiser_media": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"approval_date",
"auto_approval_date",
"name",
"subscribe_date"
]
}
},
"order_by_advertiser_media_invite": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"invite_date",
"media_name",
"status"
]
}
},
"order_by_advertiser_revenue_share": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"media_id",
"reference",
"date"
]
}
},
"order_by_advertiser_revenue_share_member": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"media_id",
"reference",
"date",
"date_click"
]
}
},
"order_by_advertiser_statistics_ad": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"ad_id",
"ad_group_name",
"program_id",
"click_raw",
"click_unique",
"cpc_raw",
"cpc_unique",
"cpc_amount",
"transaction_unique",
"transaction_amount",
"transaction_revenue",
"transaction_parts",
"transaction_open",
"transaction_open_parts",
"transaction_open_amount",
"transaction_approved",
"transaction_approved_parts",
"transaction_approved_amount",
"transaction_disapproved",
"transaction_disapproved_parts",
"transaction_disapproved_amount",
"currency_code"
]
}
},
"order_by_advertiser_statistics_cpc": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"media_id",
"media_name",
"commission",
"click_raw",
"click_unique",
"cpc_raw",
"cpc_unique",
"cpc_amount",
"currency_code"
]
}
},
"order_by_advertiser_statistics_description": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"description",
"program_id",
"program_name",
"transaction_unique",
"transaction_amount",
"transaction_revenue",
"transaction_parts",
"transaction_open",
"transaction_open_parts",
"transaction_open_amount",
"transaction_approved",
"transaction_approved_parts",
"transaction_approved_amount",
"transaction_disapproved",
"transaction_disapproved_parts",
"transaction_disapproved_amount",
"currency_code"
]
}
},
"order_by_advertiser_statistics_media": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"media_id",
"media_name",
"click_raw",
"click_unique",
"cpc_raw",
"cpc_unique",
"cpc_amount",
"transaction_unique",
"transaction_amount",
"transaction_revenue",
"transaction_parts",
"transaction_open",
"transaction_open_parts",
"transaction_open_amount",
"transaction_approved",
"transaction_approved_parts",
"transaction_approved_amount",
"transaction_disapproved",
"transaction_disapproved_parts",
"transaction_disapproved_amount",
"currency_code"
]
}
},
"order_by_advertiser_statistics_program": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"program_id",
"program_name",
"click_raw",
"click_unique",
"cpc_raw",
"cpc_unique",
"cpc_amount",
"transaction_unique",
"transaction_amount",
"transaction_revenue",
"transaction_parts",
"transaction_open",
"transaction_open_parts",
"transaction_open_amount",
"transaction_approved",
"transaction_approved_parts",
"transaction_approved_amount",
"transaction_disapproved",
"transaction_disapproved_parts",
"transaction_disapproved_amount",
"currency_code"
]
}
},
"order_by_advertiser_statistics_publisher": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"publisher_id",
"publisher_name",
"click_raw",
"click_unique",
"cpc_raw",
"cpc_unique",
"cpc_amount",
"transaction_unique",
"transaction_amount",
"transaction_revenue",
"transaction_parts",
"transaction_open",
"transaction_open_parts",
"transaction_open_amount",
"transaction_approved",
"transaction_approved_parts",
"transaction_approved_amount",
"transaction_disapproved",
"transaction_disapproved_parts",
"transaction_disapproved_amount",
"currency_code"
]
}
},
"order_by_advertiser_subscription": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"advertiser_id",
"advertiser_name",
"approval_date",
"auto_approval_date",
"channel_id",
"cpc_status",
"media_name",
"publisher_name",
"status",
"subscribe_date"
]
}
},
"order_by_advertiser_transaction_batch_job": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"creation_date",
"error_count",
"status"
]
}
},
"order_by_advertiser_transaction_v2": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"program_name",
"transaction_publisher_commission",
"transaction_revenue",
"transaction_status"
]
}
},
"order_by_deeplink": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"id",
"modified_date"
]
}
},
"order_by_invoice": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"date_due",
"reference"
]
}
},
"order_by_mailingapproval": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"program_name",
"send_date",
"status",
"subject"
]
}
},
"order_by_marketplace_offers_advertiser": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"annual_event_name",
"date_from",
"date_until",
"media_name",
"relevance",
"type_name"
]
}
},
"order_by_marketplace_order": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"requested_delivery_date",
"program_name",
"status",
"media_name",
"type_name",
"annual_event_name"
]
}
},
"order_by_media_group_category": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"id"
]
}
},
"order_by_media_group_country_code": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"country_code"
]
}
},
"order_by_media_group_filter_language": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"language_code"
]
}
},
"order_by_media_group_media": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"name"
]
}
},
"order_by_media_group_publisher": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"name"
]
}
},
"order_by_media_group_type": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"type"
]
}
},
"order_by_news": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"program_name",
"source",
"title"
]
}
},
"order_by_notification": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"id",
"level",
"program_name",
"send_date",
"sender_name",
"title"
]
}
},
"order_by_product_feed": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"id",
"last_check_date",
"last_download_date",
"last_modified_date",
"last_run_date",
"next_run_date",
"program_id",
"standard_id",
"standard_name"
]
}
},
"order_by_promotion": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"name",
"status_date",
"type_amount"
]
}
},
"order_by_referrer_param": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"id",
"name",
"value"
]
}
},
"order_by_transaction": {
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"date_click",
"media_name",
"program_name",
"publisher_commission_potential",
"revenue",
"subid",
"transaction_status"
]
}
},
"order_direction": {
"name": "order_direction",
"in": "query",
"description": "Order direction",
"required": false,
"schema": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
]
}
},
"paginator_page": {
"name": "page",
"in": "query",
"description": "Paginator page",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
"paginator_per": {
"name": "per_page",
"in": "query",
"description": "Paginator results per page (max 1000)",
"required": false,
"schema": {
"type": "integer",
"default": 100
}
},
"parameter_media_status": {
"name": "media_status",
"in": "query",
"description": "Media status ('active', 'deleted', 'offline')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"active",
"deleted",
"offline"
]
}
},
"parameter_publisher_status": {
"name": "publisher_status",
"in": "query",
"description": "Publisher status ('active', 'deleted')",
"required": false,
"explode": false,
"schema": {
"type": "string",
"enum": [
"active",
"deleted"
]
}
},
"part_id": {
"name": "part_id",
"in": "path",
"description": "Transaction part ID",
"required": true,
"schema": {
"type": "string"
}
},
"permission": {
"name": "permission",
"in": "path",
"description": "Permission",
"required": true,
"schema": {
"type": "integer"
}
},
"phonenumber_id": {
"name": "phonenumber_id",
"in": "path",
"description": "Phonenumber ID",
"required": true,
"schema": {
"type": "integer"
}
},
"placeholder_url_media_id": {
"name": "placeholder_media_id",
"in": "query",
"description": "replace url placeholder #MEDIA_ID# value",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"placeholder_url_subid": {
"name": "placeholder_subid",
"in": "query",
"description": "replace url placeholder #SUBID# value",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"placeholder_url_subid_2": {
"name": "placeholder_subid_2",
"in": "query",
"description": "replace url placeholder #SUBID2# value",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"placeholder_url_subid_3": {
"name": "placeholder_subid_3",
"in": "query",
"description": "replace url placeholder #SUBID3# value",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
"product_feed_id": {
"name": "product_feed_id",
"in": "path",
"description": "Product feed ID",
"required": true,
"schema": {
"type": "integer"
}
},
"productfeed_id": {
"name": "productfeed_id",
"in": "path",
"description": "Productfeed ID",
"required": true,
"schema": {
"type": "integer"
}
},
"program_id": {
"name": "program_id",
"in": "path",
"description": "Program ID",
"required": true,
"schema": {
"type": "integer"
}
},
"promotion_id": {
"name": "promotion_id",
"in": "path",
"description": "Promotion ID",
"required": true,
"schema": {
"type": "integer"
}
},
"publisher_document_id": {
"name": "publisher_document_id",
"in": "path",
"description": "publisher document id",
"required": true,
"schema": {
"type": "integer"
}
},
"publisher_id": {
"name": "publisher_id",
"in": "path",
"description": "Publisher ID",
"required": true,
"schema": {
"type": "integer"
}
},
"question_id": {
"name": "question_id",
"in": "path",
"description": "Question ID",
"required": true,
"schema": {
"type": "integer"
}
},
"questionnaire_id": {
"name": "questionnaire_id",
"in": "path",
"description": "Questionnaire ID",
"required": true,
"schema": {
"type": "integer"
}
},
"referrer_param_id": {
"name": "param_id",
"in": "path",
"description": "Referrer Param ID",
"required": true,
"schema": {
"type": "integer"
}
},
"ticket_id": {
"name": "ticket_id",
"in": "path",
"description": "ticket ID",
"required": true,
"schema": {
"type": "integer"
}
},
"user_id": {
"name": "user_id",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"description": "JWT Bearer token",
"bearerFormat": "JWT",
"scheme": "bearer"
},
"oAuth": {
"type": "oauth2",
"description": "OAuth 2.1 with PKCE for daisycon.com",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://login.daisycon.com/oauth/authorize",
"tokenUrl": "https://login.daisycon.com/oauth/access-token",
"refreshUrl": "https://login.daisycon.com/oauth/access-token",
"scopes": {}
}
}
}
}
},
"security": [
{
"bearerAuth": []
},
{
"oAuth": []
}
],
"tags": [
{
"name": "/advertisers/businessinfo",
"description": "/advertisers/businessinfo"
},
{
"name": "/advertisers/address",
"description": "/advertisers/address"
},
{
"name": "/advertisers/agreementterms",
"description": "/advertisers/agreementterms"
},
{
"name": "/advertisers/apps/connected",
"description": "/advertisers/apps/connected"
},
{
"name": "/advertisers/clearinghouse",
"description": "/advertisers/clearinghouse"
},
{
"name": "/advertisers/consumers/descriptions",
"description": "/advertisers/consumers/descriptions"
},
{
"name": "/advertisers/consumers/delivery",
"description": "/advertisers/consumers/delivery"
},
{
"name": "/advertisers/programs/contract",
"description": "/advertisers/programs/contract"
},
{
"name": "/advertisers/financial/invoices",
"description": "/advertisers/financial/invoices"
},
{
"name": "/advertisers/google/permissions",
"description": "/advertisers/google/permissions"
},
{
"name": "/advertisers/interfacesettings",
"description": "/advertisers/interfacesettings"
},
{
"name": "/advertisers/leads",
"description": "/advertisers/leads"
},
{
"name": "/advertisers/leaddata",
"description": "/advertisers/leaddata"
},
{
"name": "/advertisers/mailings",
"description": "/advertisers/mailings"
},
{
"name": "/advertisers/material/ad-groups",
"description": "/advertisers/material/ad-groups"
},
{
"name": "/advertisers/material/ads",
"description": "/advertisers/material/ads"
},
{
"name": "/advertisers/material/promotions",
"description": "/advertisers/material/promotions"
},
{
"name": "/advertisers/material/deeplinks",
"description": "/advertisers/material/deeplinks"
},
{
"name": "/advertisers/media",
"description": "/advertisers/media"
},
{
"name": "/advertisers/media/groups",
"description": "/advertisers/media/groups"
},
{
"name": "/advertisers/news",
"description": "/advertisers/news"
},
{
"name": "/advertisers/notifications",
"description": "/advertisers/notifications"
},
{
"name": "/advertisers/notifications/receive",
"description": "/advertisers/notifications/receive"
},
{
"name": "/advertisers/notification/templates",
"description": "/advertisers/notification/templates"
},
{
"name": "/advertisers/payment",
"description": "/advertisers/payment"
},
{
"name": "/advertisers/phonenumbers",
"description": "/advertisers/phonenumbers"
},
{
"name": "/advertisers/productfeeds",
"description": "/advertisers/productfeeds"
},
{
"name": "/advertisers/programs",
"description": "/advertisers/programs"
},
{
"name": "/advertisers/tracking-settings",
"description": "/advertisers/tracking-settings"
},
{
"name": "/advertisers/programs/referrer",
"description": "/advertisers/programs/referrer"
},
{
"name": "/advertisers/publishers",
"description": "/advertisers/publishers"
},
{
"name": "/advertisers/publishers/details",
"description": "/advertisers/publishers/details"
},
{
"name": "/advertisers/publisherdocuments",
"description": "/advertisers/publisherdocuments"
},
{
"name": "/advertisers/media/questionnaires",
"description": "/advertisers/media/questionnaires"
},
{
"name": "/advertisers/revshare",
"description": "/advertisers/revshare"
},
{
"name": "/advertisers/statistics",
"description": "/advertisers/statistics"
},
{
"name": "/advertisers/subscriptions",
"description": "/advertisers/subscriptions"
},
{
"name": "/advertisers/tickets",
"description": "/advertisers/tickets"
},
{
"name": "/advertisers/system-notifications/receive",
"description": "/advertisers/system-notifications/receive"
},
{
"name": "/advertisers/transactions/batchprocessing/jobs",
"description": "/advertisers/transactions/batchprocessing/jobs"
},
{
"name": "/advertisers/transactions",
"description": "/advertisers/transactions"
},
{
"name": "/advertisers/transactions/attachments",
"description": "/advertisers/transactions/attachments"
},
{
"name": "/advertisers/transactionsv2",
"description": "/advertisers/transactionsv2"
},
{
"name": "/advertisers/user",
"description": "/advertisers/user"
},
{
"name": "/advertisers",
"description": "/advertisers"
},
{
"name": "/advertisers/product-feeds",
"description": "/advertisers/product-feeds"
},
{
"name": "/advertisers/product-feeds/settings",
"description": "/advertisers/product-feeds/settings"
},
{
"name": "/advertisers/marketplace",
"description": "/advertisers/marketplace"
},
{
"name": "/advertisers/media/distribution-groups",
"description": "/advertisers/media/distribution-groups"
},
{
"name": "/advertisers/media/media-kits",
"description": "/advertisers/media/media-kits"
},
{
"name": "/advertisers/programs/access-rules",
"description": "/advertisers/programs/access-rules"
},
{
"name": "/advertisers/media-invites",
"description": "/advertisers/media-invites"
},
{
"name": "/advertisers/program/commissions",
"description": "/advertisers/program/commissions"
},
{
"name": "/advertisers/programs/description",
"description": "/advertisers/programs/description"
},
{
"name": "/advertisers/programs/deep-linking",
"description": "/advertisers/programs/deep-linking"
},
{
"name": "/advertisers/programs/criteria",
"description": "/advertisers/programs/criteria"
},
{
"name": "/advertisers/programs/target",
"description": "/advertisers/programs/target"
},
{
"name": "/advertisers/clicks",
"description": "/advertisers/clicks"
},
{
"name": "/advertisers/transactions/programs",
"description": "/advertisers/transactions/programs"
},
{
"name": "/advertisers/change-proposals",
"description": "/advertisers/change-proposals"
},
{
"name": "/advertisers/financial",
"description": "/advertisers/financial"
},
{
"name": "/advertisers/lookup",
"description": "/advertisers/lookup"
}
],
"externalDocs": {
"description": "Documentation",
"url": "https://daisycon.com/en/developers/"
}
}