openapi: 3.0.1 info: title: Partnerize Brands API version: 1.4.99 description: "# Introduction\n\nThis is the full external API documentation for\ \ the [Partnerize](http://partnerize.com/) API. The API is organised around REST\ \ principles like resource-oriented URLs and uses standard HTTP features like\ \ response codes, verbs and Authentication. At Partnerize, we build features API-first\ \ and have built our web application on top of the API as we want to make our\ \ core functionality available to developers to consume programmatically.\n\n\ You can refer to the API reference for a full list of supported endpoints. If\ \ it is the first time you are using the API, go to the [_Quick Start_](#section/Quick-Start)\ \ section for a quick start tutorial on making your first API call.\n\n# Versioning\n\ \n Currently there are three global versions of the Partnerize API. You can distinguish\ \ between them by looking at the endpoint URL. First version endpoints do not\ \ include a version in the path: e.g. `https://api.partnerize.com/network/`. Second\ \ and third version endpoints can be identified by the `v2` and `v3` in the URL:\ \ e.g. `https://api.partnerize.com/v2/campaigns/{campaignId}/commissions` or `https://api.partnerize.com/v3/brand/campaigns/{campaignId}/conversions/bulk`.\ \ \n Since the versions are global, there are common conventions that apply to\ \ all API versions as well as version specific ones. The sections below describe\ \ these conventions in detail.\n\n# Quick Start\n\nThis tutorial takes you through\ \ creating your first Partnerize API call. The example below demonstrates how\ \ to:\n\n1. Obtain your API keys\n2. Generate an Authorization header\n3. Make\ \ your first Partnerize API request\n\n*Step 1.* Obtaining your API keys\n\n1.\ \ Login to the Partnerize console at [https://console.partnerize.com](https://console.partnerize.com/).\n\ 2. Go to Settings – the _User Application Key_ and User _API key_ can be found\ \ under Account settings.\n\n*Step 2.* Generate an Authorization header\n\nAuthentication\ \ is achieved by providing an Authorization header in the following format:\n\n\ `Authorization: Basic cDN0ZXcxNDV5M3RhZzQxbjowaHkzNGho`\n\nWhere `cDN0ZXcxNDV5M3RhZzQxbjowaHkzNGho`\ \ is the Base64 encoding of the _User Application Key_ and _User API key_ joined\ \ by a colon ':'.\n\nRefer to the [_Access and Authentication_](#section/Common-API-Conventions/Access-and-Authentication)\ \ section for more details.\n\n*Step 3.* Make your first Partnerize API request\n\ \nIn this step you are going to make a call to the "Networks" endpoint\ \ to retrieve a list of all networks your user has access to.\n\nIn the example\ \ below, replace the {personal\\_token} with the one generated in the previous\ \ step:\n\n`curl -X GET https://api.partnerize.com/network -H 'Authorization:\ \ Basic {personal_token}'`\n\nThe response will contain a collection of networks:\n\ \n```\n{\n \"count\": 1,\n \"execution_time\": \"0.20239 seconds\",\n \ \ \"networks\": [\n {\n \"network\": {\n \"\ network_id\": 1,\n \"network_name\": \"Partnerize\",\n \ \ \"network_description\": \"Test Network\",\n \"network_notes\"\ : \"This is a test Partnerize network\",\n \"network_application_id\"\ : 2,\n \"auto_approve_publishers\": \"n\",\n \"\ default_campaign_id\": null,\n \"cm_client_id\": “b4d0d85cff813cdce092c261b2b200”,\n\ \ \"network_contact_email\": null,\n \"network_locale\"\ : \"en\"\n }\n }\n ]\n}\n``` \n\n# API Change Management\ \ Policy\n\n## Types of changes\n\n### Backwards-compatible changes\n\nConsumers\ \ of the Partnerize API should ensure that their applications can handle backwards-compatible\ \ changes. Examples of what Partnerize considers to be backwards-compatible changes:\n\ \n* Introducing new resources\n* Introducing new optional request parameters to\ \ existing API resources\n* Introducing new properties in the responses of existing\ \ API resources\n* Introducing new methods to existing API resources\n* Introducing\ \ new headers to existing responses\n* Changing the order of existing response\ \ properties\n\nPartnerize will be making backwards-compatible changes without\ \ advanced notice. The changes will be communicated by updating the API documentation.\ \ \n\n### Breaking changes\n\nBreaking changes would usually require changes in\ \ the code of a Partnerize API consumer. Examples of what Partnerize considers\ \ to be breaking changes:\n\n* Removing a resource (see _API Resource Deprecation_\ \ below)\n* Removing or renaming properties in existing responses\n* Removing\ \ documented response headers\n* Introducing new mandatory request parameters\ \ or header\n* Making an optional request parameter or header to mandatory\n\n\ Partnerize will announce breaking changes at least 3 months in advance. \n\n\ ### Hotfix changes\n\nPartnerize may introduce either breaking or backwards-compatible\ \ changes if required to address stability or security issues. In the rare situation\ \ of that happening Partnerize reserves the right to make those changes without\ \ the agreed minimum notice period announcement. \n\n## API resource deprecation\n\ \nPartnerize will give API consumers at least 3 months notice about deprecating\ \ an API resource. Partnerize will notify affected consumers via email with instructions\ \ about the upgrade process. Once the announcement is made the resource will\ \ be marked as `Obsolete` in the API documentation together with an alternative\ \ new functionality to use. \n\n# Common API Conventions\n\n## Terminology\n\n\ Older API endpoints may refer to _Brands_ as _Advertisers_ and _Partners_ as _Publishers_.\ \ Those terms are used interchangeably throughout the API reference. The reference\ \ in this set of documents is the single source of truth for the interface specification.\ \ \n\n## Access and Authentication\n\nThe Partnerize API uses HTTP Basic Authentication.\ \ You must have valid application\\_key and user\\_api\\_key to make API requests.\ \ Refer to the [_Quick Start_](#section/Quick-Start) tutorial for details on how\ \ to obtain these. The application\\_key identifies the Network you are making\ \ the request against and the user\\_api\\_key identifies the User on whose behalf\ \ the request is made. The keys are sent as part of an _Authorization_ header\ \ which value contains the word Basic followed by space and a base-64-encoded\ \ string *username:password*, where:\n\n- username: *application\\_key*\n- password:\ \ *user\\_api\\_key*\n\n `Authorization: Basic cDN0ZXcxNDV5M3RhZzQxbjowaHkzNGho`\n\ \nAccess to data and operations of certain endpoints is dependent on the access\ \ rights of the user. \n\n## Requests\n\nAll API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS)\ \ and contain a valid Authorization header value.\n\n## Standard Pagination\n\n\ Certain endpoints will generate large result sets. To save bandwidth and long\ \ processing times, these endpoints will paginate the results to reduce the strain\ \ on both client and server.\n\nAny endpoint that supports pagination will return\ \ 3 attributes to support this:\n\n- `offset` the current offset of the data returned\n\ - `limit` the number of results to which the output was restricted\n- `count`\ \ the total number of results available\n\nIf `offset` combined with `limit` is\ \ less than the overall count, the results have been truncated. Therefore, to\ \ consume all data you will need to page through the result set.\n\n### Paging\n\ \nTo paginate through a result set, you can use a combination of 2 parameters:\n\ \n| **Parameter** | **Description** | **Notes** |\n| --- | --- | --- |\n| `offset`\ \ | Offset the results by a given amount | Integer, defaults to `0` |\n| `limit`\ \ | Limit the number of results returned | Integer, maximum limit is defined in\ \ result set headers |\n\nFor example, if an endpoint produces 500 results, only\ \ the first 300 will be returned (results `0` to `299`). In order to retrieve\ \ the remaining results, implement the `offset` GET param. In this example, adding\ \ `offset=300` to the query string parameters.\n\nThere are 2 considerations when\ \ doing this:\n\n- Results begin at `offset 0`. If you're retrieving a report\ \ with `limit=300`, page 2 will begin at `offset=300`, page 3 at `offset=600`,\ \ page 4 at `offset=900`, etc.\n- The reports you generate are based on live data,\ \ and could be subject to continuous, incremental changes. If your query covers\ \ a particularly busy data set, then data inserts or updates may occur between\ \ paging.\n\n### Hypermedia\n\nIt can be cumbersome to manage pagination programmatically,\ \ especially when attempting to rapidly prototype. To provide some helpful assistance,\ \ the API will output a `hypermedia` node for all paginated result sets. Essentially\ \ this performs all necessary calculations and outputs all relevant information\ \ with absolute URI's to assist easier pagination.\n\n```\n\"hypermedia\"\ : {\n \"pagination\": {\n \"total_page_count\": 15,\n \"total_item_count\"\ : 51234,\n \"first_page\": \"/user.json?limit=100&offset=0\",\n \ \ \"last_page\": \"/user.json?limit=100&offset=1400\",\n \"next_page\"\ : \"/user.json?limit=100&offset=100\",\n \"previous_page\": null\n }\n\ }\n```\n\n## Cursor Pagination\n\nFor the granular conversion reporting endpoint,\ \ we have adopted cursor based pagination. Due to the scale of some clients, there\ \ is a large overhead involved in processing the offset and computing the total\ \ number of results. This overhead compounds as the data set size increases, and\ \ when the data set grows large enough it becomes impractical to perform the task\ \ in real time.\n\nTo ensure these high volume endpoints can scale, cursor based\ \ pagination has been implemented, where each response will now return a `cursor_id`\ \ attribute along with the results. This indicates where the client is currently\ \ within the result set. When the client requests another page, and includes the\ \ `cursor_id` value, the server will be able to determine where the client is\ \ up to in the result set and send the appropriate items.\n\nThis approach does\ \ not suffer from the same overhead drawbacks that limit/offset pagination does,\ \ and provides a consistent view of the result set across pages.\n\n### Paging\n\ \nTo paginate through a result set, you can use a combination of 2 parameters:\n\ \n| **Parameter** | **Description** | **Notes** |\n| --- | --- | --- |\n| `cursor_id`\ \ | Cursor value that defines client position in result set | Integer |\n| `limit`\ \ | Limit the number of results returned | Integer, maximum limit is 300 |\n\n\ For example, if an endpoint produces 5,000 results, only the first 300 will be\ \ returned (results 0 to 299). Within the header attributes, a `cursor_id` will\ \ be included. Simply pass the `cursor_id` in conjunction with the desired limit\ \ to return the subsequent items from the result set.\n\n### Hypermedia\n\nThe\ \ hypermedia object has been updated to automatically include the relevant `cursor_id`\ \ and limit for the next page.\n\n```\n\"hypermedia\": {\n \"pagination\":\ \ {\n first_page: \"/reporting/report_publisher/publisher/10l1/conversion.json?start_date=2018-03-01+00%3A00%3A00&end_date=2018-04-01+00%3A00%3A00&limit=300\"\ ,\n next_page: \"/reporting/report_publisher/publisher/10l1/conversion.json?start_date=2018-03-01+00%3A00%3A00&end_date=2018-04-01+00%3A00%3A00&limit=300&cursor_id=10325942995\"\ \n }\n}\n```\n\n## Rate Limits\n\nTo protect our API users, API endpoints will\ \ rate limit based on usage.\nIf violated, the API will respond with with a 429\ \ http status code with the following body:\n\nv1 API:\n\n {\n \"error\"\ : {\n \"message\": \"Too Many Requests\",\n \"type\": \"\ 429\"\n }\n }\n\nv2 API:\n\n {\n \"error\": {\n \"errors\"\ : [\n ],\n \"code\": \"429\",\n \"message\": \"Too Many Requests\"\ \n }\n }\n\nv3 API:\n\n {\n \"error\": {\n \"errors\":\ \ [\n {\n \"property\": \"\",\n \"message\": \"\ You have made too many requests recently, please try again later.\",\n \ \ \"code\": \"3b22ff00-96a5-4fa4-96cc-f36e68dbd2e2\",\n \"type\"\ : \"too_many_requests\"\n }\n ],\n \"message\": \"Too Many\ \ Requests\",\n \"code\": \"429\"\n }\n }\n\nTo help monitor your\ \ API usage, the following headers will be returned via the API to help moderate\ \ the integration:\n\n| Code | Data Type | Description \ \ |\n|-------------------------|-----------|-------------------------------------------------------|\n\ | `X-RateLimit-Limit` | integer | How many tokens are permitted \ \ |\n| `X-RateLimit-Remaining` | integer | How many tokens\ \ are left in the specified time period |\n| `X-RateLimit-Reset` | integer\ \ | How many seconds until the throttle resets itself |\n| `X-RateLimit-Retry-After`\ \ | integer | How mow many seconds to wait to retry |\n\n# Version\ \ 1 API Conventions\n\n## Requests\n\n### Base URL\n\nThe base URL for version\ \ 1 API endpoints is [https://api.partnerize.com/](https://api.partnerize.com/)\n\ \n## Response Formats\n\nThe default response format is JSON. You can specify\ \ the response format of each request, by adding a file extension suffix to the\ \ end of the request URI. The requested format will dictate the HTTP Content-Type\ \ header that is returned in the response. Currently, there are 3 available formats:\n\ \n| **Format** | **Header** | **Notes** |\n| --- | --- | --- |\n| `.json` | `Content-Type:\ \ application/json` | |\n| `.xml` | `Content-Type: text/xml` | |\n| `.csv`\ \ | `Content-Type: application/octet-stream` | Only available on specific endpoints\ \ |\n\n\n## Rate limit response\nWhenever too many requests are sent through within\ \ a period of time the response will be an error with an http status code 429\ \ Too Many Requests. See [Rate limits](#section/Common-API-Conventions/Rate-Limits)\ \ for more information on this.\n\n\n**Sample JSON response body when a rate limit\ \ is hit.**\n```\n{\n \"error\": {\n \"message\": \"Too Many\ \ Requests\",\n \"type\": \"429\"\n }\n }\n```\n\n## Compression\n\ \nThe API is compression-enabled. To control whether the API response is compressed,\ \ send the relevant `Accept-Encoding` HTTP header:\n\n- Request: `Accept-Encoding:\ \ gzip`\n- Response: `Content-Encoding: gzip`\n\n# Version 2 API Conventions\n\ \n## Requests\n\n### Base URL\n\nThe base URL for version 2 API endpoints is [https://api.partnerize.com/v2](https://api.partnerize.com/v2).\n\ \n### Supported HTTP Verbs\n\nPartnerize's API uses appropriate HTTP verbs\ \ where possible. Endpoints support one or more of the following HTTP verbs:\n\ \nGET – GET requests retrieve one or more entities and are always read-only. A\ \ successful request returns a response with a 200 _OK_ status code.\n\nPOST –\ \ POST requests are mainly are used to create Partnerize entities or batch operations.\ \ When successful such a request returns a 201 _Created_ response code. In the\ \ cases when the POST request is used for batch operations processing is done\ \ asyncronously. In those cases the successful request will return a 202 _Accepted_\ \ response code and the response should contain a job id, which can be used to\ \ monitor the status of the processing. \n\nPUT – PUT request update the resource\ \ provided in the URL. PUT requests are idempotent and result in the resource\ \ being replaced. A successful request returns a response with a 200 _OK_ status\ \ code.\n\nPATCH – Used to do partial updates to Partnerize entities. A successful\ \ request returns a response with a 200 _OK_ status code.\n\nDELETE – DELETE requests\ \ can be used to remove an entity when supported. A successful request returns\ \ a response with a 200 _OK_ or a 204 _No Content_ status code.\n\nIf an endpoint\ \ doesn't support a particular method, it will return a response with a 405\ \ _Method Not Allowed_ code.\n\n## Responses\n\nVersion 2 API endpoints return\ \ response data as a JSON object. Refer to the API reference for details of each\ \ endpoint responses. The response will include one of the following HTTP status\ \ codes:\n\n### HTTP Status Codes Summary\n\n| **HTTP Status Code** | **Description**\ \ |\n| --- | --- |\n| `200 OK` | The request was successfully completed. A 200\ \ status is returned for a successful GET, PUT, PATCH and sometimes DELETE methods.\ \ |\n| `201 Created` | The request was successful and a resource was created.\ \ The response usually includes an identifier for the newly created resource.\ \ |\n| `202 Accepted` | Some of the requests, e.g. bulk are handled by background\ \ jobs. This response status code indicates that the request was received and\ \ handed over for processing.|\n| `204 No content` | The request was successfully\ \ completed and there is no payload in the response. |\n| `400 Bad Request` |\ \ The request could not be processed because it contains missing or invalid information.\ \ See [Errors](#section/Version-2-API-Conventions/Errors) for more details. |\n\ | `401 Unauthorized` | The request is not authorized. The request could not be\ \ authenticated becuase of wrong or invalid credentials used in the Authorization\ \ header. |\n| `403 Forbidden` | The user is not authorized to perform this action.\ \ |\n| `404 Not Found` | The request includes a resource URI that cannot be found\ \ by the server. |\n| `405 Method Not Allowed` | The request method, e.g. POST,\ \ is not allowed for the resource identified by the request URI. |\n| `429 Too\ \ Many Requests` | The user has exceeded the quota for a particular request. See\ \ [Rate limits](#section/Common-API-Conventions/Rate-Limits) for more information\ \ on this. |\n| `500 Internal Server Error` | Generic server error. The server\ \ encountered an unexpected condition that prevented it from fulfilling the request.\ \ |\n| `503 Internal Server Error` | The service is temporarily unavailable. |\n\ \nSee the [Errors](#section/Version-2-API-Conventions/Errors) section below for\ \ more details on error responses.\n\n### Response format\n\n#### Top level attributes\n\ \nEach response document contains an `execution_time` top level attribute. \n\n\ #### Collections response\n\nIn addition to the `execution_time` top level attribute,\ \ a collection response contains a `count` one, which represents the total number\ \ of resources in the collection.\n\nExample:\n\n```\n{\n \"execution_time\"\ : \"1.11761 seconds\",\n \"count\": 0,\n \"commissions\": []\n}\n``` \n\n\ #### Single resource response\n\nExample:\n\n```\n{\n \"execution_time\": \"\ 1.11761 seconds\",\n \"commission\": {\n \"id\": '1234',\n }\n}\n```\ \ \n\n## Errors\n\nThe Version 2 API uses the above mentioned standard HTTP status\ \ codes to indicate the success or failure of the API calls.\nThe body of the\ \ response will be JSON in the following format:\n\n```\n{\n \"error\": {\n \ \ \"errors\": [\n {\n \"property\": \"evaluation_period\",\n \ \ \"type\": \"validation_error\",\n \"code\": \"required_property\"\ ,\n \"message\": \"Parameter 'evaluation_period' is required\"\n }\n\ \ ],\n \"code\": \"400\",\n \"message\": \"Bad Request\"\n }\n}\n```\n\ \n| Attribute | Type | Description |\n|-----------|---|-------|\n| `errors` |\ \ array | An array of error(s) which occured which triggered the error. Each item\ \ contains the following attributes;
`property` - The attribute the error\ \ is related to.
`message` - A human-friendly message describing the error.`code` - A unique code for this type of error.
`type` - A text based\ \ error classification. |\n| `code` | string | An error code representing the\ \ error(s) which has occured, this typically matches the HTTP status code. |\n\ | `message` | string | A human-friendly message describing the error(s) which\ \ has occured. |\n\n### Bad Request (Code 400)\nIf there is an error in your input,\ \ you’ll receive a “400 Bad Request” http response. The body of the response will\ \ be JSON with the `errors` attribute containing an array of details of the error(s).\n\ \n| Code | Description |\n|--|--|\n| `invalid_property_format` | Invalid date\ \ format. |\n| `invalid_type` | Invalid parameter type. For example when an array\ \ is expected and the input was different type. |\n| `invalid_value` | The value\ \ is out of bounds. |\n| `required_property` | Missing parameter. |\n| `invalid_lower_bound`\ \ | The value is too low. |\n| `invalid_upper_bound` | The value is too hogh.\ \ |\n| `invalid_enum_value` | The value must be one of a specified list of values.\ \ |\n| `invalid_max_length` | Maximum number of characters reached. |\n| `invalid_property`\ \ | The property is invalid. |\n\n### Unauthorized (Code 401)\nIf there is an\ \ error with your authentication credentials, you’ll receive a “401 Unauthorized”\ \ http response. \n\n**Sample JSON response body**\n```\n{\n \"error\": {\n \ \ \"errors\": [\n {\n \"type\": \"error\",\n \"code\": \"\ unauthorized\",\n \"message\": \"Your API credentials can be found in Account\ \ settings. 'Username' will be your 'User application key' and 'Password' will\ \ be your 'User API key'\"\n }\n ],\n \"code\": \"401\",\n \"message\"\ : \"Unauthorized\"\n }\n}\n```\n\n### Forbidden (Code 403)\nIf there is an denial\ \ of access to a resouce within your request, you’ll receive a “403 Forbidden“\ \ http response. \n\n```\n{\n \"error\": {\n \"errors\": [\n {\n \ \ \"type\": \"error\",\n \"code\": \"unauthorized\",\n \"message\"\ : \"You do not have 'read' permission on campaign with id '1'\"\n }\n \ \ ],\n \"code\": \"403\",\n \"message\": \"Forbidden\"\n }\n}\n```\nWhen\ \ the user is not allowed to know the resource exists, i.e. they don't have READ\ \ permission on the resource, the response will have a `404 Not Found` status\ \ code.\n\n### Not Found (Code 404)\nIf there is an error locating a requested\ \ resource, you’ll receive a “404 Not Found\" http response. \n\n\n**Sample JSON\ \ response body when an invalid URL has been requested.**\n```\n{\n \"error\"\ : {\n \"errors\": [\n {\n \"type\": \"error\",\n \"code\"\ : \"entity_not_found\",\n \"message\": \"campaign not found for id '1'\"\ \n }\n ],\n \"code\": \"404\",\n \"message\": \"Not Found\"\n }\n\ }\n```\n\n### Method Not Allowed (Code 405)\nIf there is an error accessing a\ \ resource using the given HTTP verb, you’ll receive a “405 Method Not Allowed“\ \ http response. The body of the response will be JSON with the `errors` attribute\ \ containing an array of details of the error(s).\n\n\n**Sample JSON response\ \ body when an valid URL has been requested with an invalid request method.**\n\ ```\n{\n \"error\": {\n \"errors\": [\n {\n \"type\": \"error\"\ ,\n \"code\": \"routing_error\",\n \"message\": \"index not supported\"\ \n }\n ],\n \"code\": \"405\",\n \"message\": \"Method Not Allowed\"\ \n }\n}\n```\n\n### Too Many Requests (Code 429)\nThis error code indicates that\ \ too many requests were sent within a period of time. See [Rate limits](#section/Common-API-Conventions/Rate-Limits)\ \ for more information on this.\n\n\n**Sample JSON response body when a rate limit\ \ is hit.**\n```\n\n {\n \"error\": {\n \"errors\": [\n \ \ ],\n \"code\": \"429\",\n \"message\": \"Too Many Requests\"\n\ \ }\n }\n ``` \n\n## Date Time\n\n`v2` API endpoints use [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)\ \ date time format.\n\n### Example:\n\n`2019-03-01T12:01:00+00:00` - this example\ \ represents 1 minute past midday on the 1st of March 2019 in UTC.\n\n`2019-03-01`\ \ - date only example\n\n# Version 3 API Conventions\n\n## Requests\n\n### Base\ \ URL\n\nThe base URL for version 3 API endpoints is [https://api.partnerize.com/v3](https://api.partnerize.com/v3).\ \ Version 3 of the API endpoints introduces _brands_ and _partners_ context to\ \ the API. This means that the _brand_ endpoints will have the following base\ \ URL: [https://api.partnerize.com/v3/brand](https://api.partnerize.com/v3/brand)\ \ and the _partner_ ones will have: [https://api.partnerize.com/v3/partner](https://api.partnerize.com/v3/partner)\n\ \n### Supported HTTP Verbs\n\nPartnerize's API uses appropriate HTTP verbs\ \ where possible. Endpoints support one or more of the following HTTP verbs:\n\ \nGET – GET requests retrieve one or more entities and are always read-only. A\ \ successful request returns a response with a 200 _OK_ status code.\n\nPOST –\ \ POST requests are mainly are used to create Partnerize entities or batch operations.\ \ When successful such a request returns a 201 _Created_ response code. In the\ \ cases when the POST request is used for batch operations processing is done\ \ asyncronously. In those cases the successful request will return a 202 _Accepted_\ \ response code and the response should contain a job id, which can be used to\ \ monitor the status of the processing. \n\nPUT – PUT request update the resource\ \ provided in the URL. PUT requests are idempotent and result in the resource\ \ being replaced. A successful request returns a response with a 200 _OK_ status\ \ code.\n\nPATCH – Used to do partial updates to Partnerize entities. A successful\ \ request returns a response with a 200 _OK_ status code.\n\nDELETE – DELETE requests\ \ can be used to remove an entity when supported. A successful request returns\ \ a response with a 200 _OK_ or a 204 _No Content_ status code.\n\nIf an endpoint\ \ doesn't support a particular method, it will return a response with a 405\ \ _Method Not Allowed_ code.\n\n### Unrecognized request headers and parameters\n\ \n* We ignore unrecognized HTTP headers.\n* We ignore unrecognized query string\ \ parameters.\n* We return a 400 _Bad Request_ if there are unrecognized parameters\ \ in the request body.\n\n## Responses\n\nVersion 3 API endpoints return response\ \ data as a JSON object. Refer to the API reference for details of each endpoint\ \ responses. The response will include one of the following HTTP status codes:\n\ \n### HTTP Status Codes Summary\n\n| **HTTP Status Code** | **Description** |\n\ | --- | --- |\n| `200 OK` | The request was successfully completed. A 200 status\ \ is returned for a successful GET, PUT, PATCH and sometimes DELETE methods. |\n\ | `201 Created` | The request was successful and a resource was created. The response\ \ usually includes an identifier for the newly created resource. |\n| `202 Accepted`\ \ | Some of the requests, e.g. bulk are handled by background jobs. This response\ \ status code indicates that the request was received and handed over for processing.|\n\ | `204 No content` | The request was successfully completed and there is no payload\ \ in the response. |\n| `400 Bad Request` | The request could not be processed\ \ because it contains missing or invalid information. See [Errors](#section/Version-3-API-Conventions/Errors)\ \ for more details. |\n| `401 Unauthorized` | The request is not authorized. The\ \ request could not be authenticated becuase of wrong or invalid credentials used\ \ in the Authorization header. |\n| `403 Forbidden` | The user is not authorized\ \ to perform this action. |\n| `404 Not Found` | The request includes a resource\ \ URI that cannot be found by the server. |\n| `405 Method Not Allowed` | The\ \ request method, e.g. POST, is not allowed for the resource identified by the\ \ request URI. |\n| `429 Too Many Requests` | The user has exceeded the quota\ \ for a particular request. See [Rate limits](#section/Common-API-Conventions/Rate-Limits)\ \ for more information on this. |\n| `500 Internal Server Error` | Generic server\ \ error. The server encountered an unexpected condition that prevented it from\ \ fulfilling the request. |\n| `503 Internal Server Error` | The service is temporarily\ \ unavailable. |\n\nSee the [Errors](#section/Version-3-API-Conventions/Errors)\ \ section below for more details on error responses.\n\n### Response format\n\n\ #### Top level attributes\n\nEach response document contains a `data` top level\ \ attribute and may contain a `hypermedia` one. The `data` attribute wraps all\ \ response data in the payload, while `hypermedia` will contain links to related\ \ resources. \n\nExample:\n\n```\n{\n \"data\": {\n \"id\": \"111111l11\"\ ,\n ...\n },\n \"hypermedia\": {\n \"links\": {\n \"tasks\":\ \ \"/v3/jobs/111111l11/tasks\"\n }\n }\n}\n``` \n\n\n## Errors\nThe API uses\ \ standard HTTP status codes to indicate the success or failure of the API call.\n\ The body of the response will be JSON in the following format:\n\n```\n{\n \"\ error\": {\n \"errors\": [\n {\n \"property\": \"[name]\",\n \ \ \"message\": \"The attribute expected to be of type 'string' but 'integer'\ \ given.\",\n \"code\": \"6a6c32c0-de05-4301-89dd-4a72133c137f\",\n \ \ \"type\": \"validation_error\"\n }\n ],\n \"code\": \"400\",\n\ \ \"message\": \"Bad Request\"\n }\n}\n```\n\n| Attribute | Type | Description\ \ |\n|-----------|---|-------|\n| `errors` | array | An array of error(s) which\ \ occured which triggered the error. Each item contains the following attributes;`property` - The attribute the error is related to.
`message` - A human-friendly\ \ message describing the error.
`code` - A unique code for this type of error.`type` - A text based error classification. |\n| `code` | string | An error\ \ code representing the error(s) which has occured, this typically matches the\ \ HTTP status code. |\n| `message` | string | A human-friendly message describing\ \ the error(s) which has occured. |\n\n### Bad Request (Code 400)\nIf there is\ \ an error in your input, you’ll receive a “400 Bad Request” http response. The\ \ body of the response will be JSON with the `errors` attribute containing an\ \ array of details of the error(s).\n\n| Code | Description |\n|--|--|\n| `2572f7f9-e87e-4aa7-98cf-6f53c9ed5584`\ \ | A value is required for an attribute which has not been supplied. |\n| `901d8596-1b91-4e87-869f-ef66bd4ffc0c`\ \ | The value contains more items than expeceted. |\n| `b9f3a79a-6767-4947-907e-5e0934b5a641`\ \ | The value contains more attributes than expected. |\n| `6771735c-3000-49d1-a978-74aeb33d15b9`\ \ | The value does not match the expected value. |\n| `9ba6d700-08f1-45c9-bde7-873926d4d393`\ \ | The value does not contain the expected value. |\n| `aa903a6c-64ff-4f8b-830d-8967331c5ba3`\ \ | The value does not match one of the expected values. |\n| `c535eb9f-a8fd-40ce-9e99-fcd6056b55de`\ \ | The value is not higher than or equal to the maximum value. |\n| `ed574a9e-fa9d-4b3c-83ee-65ecc47fa2fb`\ \ | The value is not lower than or equal to the minimum value. |\n| `1945fae7-8937-4086-b06b-2a43da93b7e3`\ \ | The value does not match the expected format. |\n| `1098ac2a-42f4-4a46-a684-64d67b8c274c`\ \ | The value contains more items than permitted. |\n| `539b9fb0-b542-422d-992f-4428e26b39e1`\ \ | The value contains less items than permitted. |\n| `32452de9-0c46-4674-a87d-e02f469a003c`\ \ | The value contains more characters than required. |\n| `39c6adce-c253-4750-b2c1-7215713af74d`\ \ | The value contains less characters than required. |\n| `458f0977-09d2-40ee-bbe5-c21bc9ed6e48`\ \ | The value contains more attributes than expected. |\n| `4d7d63f2-28f1-45d3-b3b8-99a1bf816e53`\ \ | The value contains less attributes than expected. |\n| `d0fd75d5-9246-4c22-b395-4f6d0279555e`\ \ | The value is higher than permitted. |\n| `7ed9630d-04c4-4559-ace5-5e44f45e14e9`\ \ | The value is lower than permitted. |\n| `3dff825b-ac80-41da-a991-2f257ab60a79`\ \ | The value is not a multiple of the defined value. |\n| `80d20241-7f19-4ee2-b46d-538f7179f7fb`\ \ | The value does not match the defined pattern. |\n| `9f6fab77-488f-449d-85d3-3345c40a2a45`\ \ | The attribute value name does not match the defined pattern. |\n| `976f4746-0e09-44a7-ba46-b53527a24f6a`\ \ | The attribute value name does not match one of the expected values. |\n| `6a6c32c0-de05-4301-89dd-4a72133c137f`\ \ | The value has been supplied as an invalid type. |\n| `25772442-e9f9-4cb1-9147-65c422026404`\ \ | The value contains a duplicate value. |\n| `0a53a999-8349-4326-9135-929f25745e08`\ \ | The interval value does not represent a date-time period between the dates.\ \ |\n| `cff336e3-1245-49f4-87ec-8efe0d2e2dce` | The interval value does represent\ \ a valid date-time period. |\n| `66dad313-af0b-4214-8566-6c799be9789c` | The\ \ Business Identifier Code (BIC) value is an invalid length. |\n| `f424c529-7add-4417-8f2d-4b656e4833e2`\ \ | The Business Identifier Code (BIC) value contains invalid characters. |\n\ | `00559357-6170-4f29-aebd-d19330aa19cf` | The Business Identifier Code (BIC)\ \ value does not contain a valid bank code. |\n| `1ce76f8d-3c1f-451c-9e62-fe9c3ed486ae`\ \ | The Business Identifier Code (BIC) value does not contain a valid country\ \ code. |\n| `11884038-3312-4ae5-9d04-699f782130c7` | The Business Identifier\ \ Code (BIC) value does not contain only contain uppercase characters. |\n| `29a2c3bb-587b-4996-b6f5-53081364cea5`\ \ | The Business Identifier Code (BIC) value does not contain a valid iban country\ \ code. |\n| `183ad2de-533d-4796-a439-6d3c3852b549` | The value is empty. |\n\ | `f196f6bd-1914-4707-a32c-20536041558f` | Campaign is required. |\n| `a2ad9231-e827-485f-8a1e-ef4d9a6d5c2e`\ \ | The Credit Card value contains non-numeric characters. |\n| `a8faedbf-1c2f-4695-8d22-55783be8efed`\ \ | The Credit Card value is an invalid format. |\n| `8e179f1b-97aa-4560-a02f-2a8b42e49df7`\ \ | The value selected is not a valid choice. |\n| `11edd7eb-5872-4b6e-9f12-89923999fd0e`\ \ | The value contains too few choices. |\n| `9bd98e49-211c-433f-8630-fd1c2d0f08c3`\ \ | The value contains too many choices. |\n| `2fa2158c-2a7f-484b-98aa-975522539ff8`\ \ | The value has not been supplied. |\n| `7703c766-b5d5-4cef-ace7-ae0dd82304e9`\ \ | The value has been supplied for an unexpected attribute. |\n| `bef8e338-6ae5-4caf-b8e2-50e7b0579e69`\ \ | The value contains too few items. |\n| `756b1212-697c-468d-a9ad-50dd783bb169`\ \ | The value contains too many items. |\n| `8f900c12-61bd-455d-9398-996cd040f7f0`\ \ | The country value is not a valid country. |\n| `69945ac1-2db4-405f-bec7-d2772f73df52`\ \ | The currency value is not a valid currency. |\n| `1a9da513-2640-4f84-9b6a-4d99dcddc628`\ \ | The date-time value is not a valid date-time. |\n| `d52afa47-620d-4d99-9f08-f4d85b36e33c`\ \ | The date value is not a valid date. |\n| `5e797c9d-74f7-4098-baa3-94390c447b27`\ \ | The time value is not a valid time. |\n| `6d99d6c3-1464-4ccf-bdc7-14d083cf455c`\ \ | The value is not divisible by the defined value. |\n| `bd79c0ab-ddba-46cc-a703-a7a4b08de310`\ \ | The email value is not a valid email address. |\n| `478618a7-95ba-473d-9101-cabd45e49115`\ \ | The value does not match the expected value. |\n| `6b3befbc-2f01-4ddf-be21-b57898905284`\ \ | The value does not match the expected expression. |\n| `d2a3fb6e-7ddc-4210-8fbf-2ab345ce1998`\ \ | The file value contains a file which does not exist. |\n| `c20c92a4-5bfa-4202-9477-28e800e0f6ff`\ \ | The file value contains a non-readable file. |\n| `5d743385-9775-4aa5-8ff5-495fb1e60137`\ \ | The file value contains an empty file. |\n| `df8637af-d466-48c6-a59d-e7126250a654`\ \ | The file value contains a file which is too large. |\n| `744f00bc-4389-4c74-92de-9a43cde55534`\ \ | The file value contains a file which contains an invalid mime type. |\n| `778b7ae0-84d3-481a-9dec-35fdb64b1d78`\ \ | The value is less than the expected value. |\n| `ea4e51d1-3342-48bd-87f1-9e672cd90cad`\ \ | The value is not greater than or equal to the expected value. |\n| `de78ee2c-bd50-44e2-aec8-3d8228aeadb9`\ \ | The IBAN value does not contain a valid country code. |\n| `8d3d85e4-784f-4719-a5bc-d9e40d45a3a5`\ \ | The IBAN value contains invalid characters. |\n| `b9401321-f9bf-4dcb-83c1-f31094440795`\ \ | The IBAN value checksum failed. |\n| `c8d318f1-2ecc-41ba-b983-df70d225cf5a`\ \ | The IBAN value is not in the correct format. |\n| `e2c259f3-4b46-48e6-b72e-891658158ec8`\ \ | The IBAN value contains an unsupported country code. |\n| `2a8cc50f-58a2-4536-875e-060a2ce69ed5`\ \ | The value is not identical to the defined value. |\n| `6d55c3f4-e58e-4fe3-91ee-74b492199956`\ \ | The Image value size could not be determined. |\n| `7f87163d-878f-47f5-99ba-a8eb723a1ab2`\ \ | The Image value is too wide. |\n| `9afbd561-4f90-4a27-be62-1780fc43604a` |\ \ The Image value is too narrow. |\n| `7efae81c-4877-47ba-aa65-d01ccb0d4645` |\ \ The Image value is too tall. |\n| `aef0cb6a-c07f-4894-bc08-1781420d7b4c` | The\ \ Image value is too short. |\n| `1b06b97d-ae48-474e-978f-038a74854c43` | The\ \ Image value contains too few pixels. |\n| `ee0804e8-44db-4eac-9775-be91aaf72ce1`\ \ | The Image value contains too many pixels. |\n| `70cafca6-168f-41c9-8c8c-4e47a52be643`\ \ | The Image value aspect radio is too big. |\n| `59b8c6ef-bcf2-4ceb-afff-4642ed92f12e`\ \ | The Image value aspect radio is too small. |\n| `5d41425b-facb-47f7-a55a-de9fbe45cb46`\ \ | The Image value cannot be square. |\n| `6f895685-7cf2-4d65-b3da-9029c5581d88`\ \ | The Image value cannot be landscape. |\n| `65608156-77da-4c79-a88c-02ef6d18c782`\ \ | The Image value cannot be portrait. |\n| `5d4163f3-648f-4e39-87fd-cc5ea7aad2d1`\ \ | The Image value is corrupted. |\n| `b1b427ae-9f6f-41b0-aa9b-84511fbb3c5b`\ \ | The value does not match the format for a valid IP address. |\n| `949acbb0-8ef5-43ed-a0e9-032dfd08ae45`\ \ | The ISBN value contains too few characters. |\n| `3171387d-f80a-47b3-bd6e-60598545316a`\ \ | The ISBN value contains too many characters. |\n| `23d21cea-da99-453d-98b1-a7d916fbb339`\ \ | The ISBN value contains invalid characters. |\n| `2881c032-660f-46b6-8153-d352d9706640`\ \ | The ISBN value checksum failed. |\n| `fa54a457-f042-441f-89c4-066ee5bdd3e1`\ \ | The ISBN value does not match the ISBN-10 or ISBN-13 formats. |\n| `d53a91b0-def3-426a-83d7-269da7ab4200`\ \ | The value is not `false`. |\n| `60d2f30b-8cfa-4372-b155-9656634de120` | The\ \ value is not `null`. |\n| `6a20dd3d-f463-4460-8e7b-18a1b98abbfb` | The ISSN\ \ value contains too few characters. |\n| `37cef893-5871-464e-8b12-7fb79324833c`\ \ | The ISSN value contains too many characters. |\n| `2983286f-8134-4693-957a-1ec4ef887b15`\ \ | The ISSN value does not contain hyphens. |\n| `a663d266-37c2-4ece-a914-ae891940c588`\ \ | The ISSN value contains invalid characters. |\n| `7b6dd393-7523-4a6c-b84d-72b91bba5e1a`\ \ | The ISSN value must contain uppercase characters. |\n| `b0f92dbc-667c-48de-b526-ad9586d43e85`\ \ | The ISSN value checksum failed. |\n| `2beabf1c-54c0-4882-a928-05249b26e23b`\ \ | The value is not `true`. |\n| `0789c8ad-2d2b-49a4-8356-e2ce63998504` | The\ \ JSON value contains invalid JSON syntax. |\n| `ee65fec4-9a20-4202-9f39-ca558cd7bdf7`\ \ | The Language value contains an invalid language. |\n| `9ff3fdc4-b214-49db-8718-39c315e33d45`\ \ | The value contains too few characters. |\n| `d94b19cc-114f-4f44-9cc4-4138e80a87b9`\ \ | The value contains too many characters. |\n| `35e6a710-aa2e-4719-b58e-24b35749b767`\ \ | The value contains invalid characters for the defined character set. |\n|\ \ `079d7420-2d13-460c-8756-de810eeb37d2` | The value is greater than the expected\ \ value. |\n| `30fbb013-d015-4232-8b3b-8f3be97a7e14` | The value is not less than\ \ or equal to the expected value. |\n| `a0af4293-1f1a-4a1c-a328-979cba6182a2`\ \ | The Locale value does not contain a valid locale. |\n| `dfad6d23-1b74-4374-929b-5cbb56fc0d9e`\ \ | The Luhn value contains invalid characters. |\n| `4d760774-3f50-4cd5-a6d5-b10a3299d8d3`\ \ | The Luhn value checksum failed. |\n| `c1051bb4-d103-4f74-8988-acbcafc7fdc3`\ \ | The value is blank. |\n| `d9bcdbfe-a9d6-4bfa-a8ff-da5fd93e0f6d` | The Password\ \ value has been compromised. e.g. the Password value has been made public by\ \ a data breach. |\n| `aa2e33da-25c8-4d76-8c6c-812f02ea89dd` | The value is not\ \ equal to the defined value. |\n| `4aaac518-0dda-4129-a6d9-e216b9b454a0` | The\ \ value is not identical to the defined value. |\n| `ad32d13f-c3d4-423b-909a-857b961eb720`\ \ | The value is null. |\n| `ad9a9798-7a99-4df7-8ce9-46e416a1e60b` | The numeric\ \ value does not exclusively contain numeric characters. |\n| `2d28afcb-e32e-45fb-a815-01c431a86a69`\ \ | The numeric value is too high and exists outside the defined range. |\n| `76454e69-502c-46c5-9643-f447d837c4d5`\ \ | The numeric value is too low and exists outside the defined range. |\n| `de1e3db3-5ed4-4941-aae4-59f3667cc3a3`\ \ | The value does not match the defined regular expression. |\n| `9d27b2bb-f755-4fbf-b725-39b1edbdebdf`\ \ | The Time value does not match the time format. |\n| `8532f9e1-84b2-4d67-8989-0818bc38533b`\ \ | The Time value does not present a valid time value. |\n| `5ce113e6-5e64-4ea2-90fe-d2233956db13`\ \ | The Timezone value does not contain a valid value. |\n| `b57767b1-36c0-40ac-a3d7-629420c775b8`\ \ | The Timezone value does not exist within the defined zone. |\n| `c4a22222-dc92-4fc0-abb0-d95b268c7d0b`\ \ | The Timezone value does not exist within the defined country. |\n| `45863c26-88dc-41ba-bf53-c73bd1f7e90d`\ \ | The Timezone value is an invalid internationalization code. |\n| `ba785a8c-82cb-4283-967c-3cf342181b40`\ \ | The value has not been supplied in the correct format. e.g. as a number `1`\ \ rather than a quoted value `\"1\"`. |\n| `7911c98d-b845-4da0-94b7-a8dac36bc55a`\ \ | The value does not contain unique elements. |\n| `57c2f299-1154-4870-89bb-ef3b1f5ad229`\ \ | The URL value does not contain a value URL. |\n| `aa314679-dac9-4f54-bf97-b2049df8f2a3`\ \ | The UUID value contains too few characters. |\n| `494897dd-36f8-4d31-8923-71a8d5f3000d`\ \ | The UUID value contains too many characters. |\n| `51120b12-a2bc-41bf-aa53-cd73daf330d0`\ \ | The UUID value contains invalid characters. |\n| `98469c83-0309-4f5d-bf95-a496dcaa869c`\ \ | The UUID value contains hyphens in invalid positions. |\n| `21ba13b4-b185-4882-ac6f-d147355987eb`\ \ | The UUID value contains an invalid version number. |\n| `164ef693-2b9d-46de-ad7f-836201f0c2db`\ \ | The UUID value's first two characters do not sum to ten. |\n| `f645b551-53ae-4e8b-8ce8-1c747e9df1e2`\ \ | This value is already used. |\n\n### Authorized (Code 401)\nIf there is an\ \ error with your authentication credentials, you’ll receive a “401 Unauthorized”\ \ http response. The body of the response will be JSON with the `errors` attribute\ \ containing an array of details of the error(s).\n\n| Code | Description |\n\ |--|--|\n| `39b4b7c2-e5b9-41b1-83d4-db3b23b5ebfa` | The authentication credentials\ \ are missing or are an invalid `User application key` and `User API key` combination.\ \ |\n\n**Sample JSON response body when no credentials has been supplied.**\n\ ```\n{\n \"error\": {\n \"errors\": [\n {\n \"property\": \"\"\ ,\n \"message\": \"Your API credentials can be found in Account settings.\ \ 'Username' will be your 'User application key' and 'Password' will be your 'User\ \ API key'.\",\n \"code\": \"39b4b7c2-e5b9-41b1-83d4-db3b23b5ebfa\",\n\ \ \"type\": \"unauthorised\"\n }\n ],\n \"message\": \"Unauthorized\"\ ,\n \"code\": \"401\"\n }\n}\n```\n**Sample JSON response body when an invalid\ \ `User application key` and `User API key` combination has been supplied.**\n\ ```\n{\n \"error\": {\n \"errors\": [\n {\n \"property\": \"\"\ ,\n \"message\": \"Your 'User application key' and 'User API key' combination\ \ is invalid.\",\n \"code\": \"39b4b7c2-e5b9-41b1-83d4-db3b23b5ebfa\",\n\ \ \"type\": \"unauthorised\"\n }\n ],\n \"message\": \"Unauthorized\"\ ,\n \"code\": \"401\"\n }\n}\n```\n\n### Forbidden (Code 403)\nIf there is\ \ an denial of access to a resouce within your request, you’ll receive a “403\ \ Forbidden“ http response. The body of the response will be JSON with the `errors`\ \ attribute containing an array of details of the error(s).\n\n| Code | Description\ \ |\n|--|--|\n| `76fb121a-d769-4293-852d-3b9b6a3dcce8` | Access has not been permitted\ \ to a resource or to perform an action. |\n| `16bd7f4a-bf84-45c3-aa95-9b32aeb139b0`\ \ | Access has not been permitted to a resource or to perform an action. |\n|\ \ `f0b71be3-c8be-4ff2-893e-2bc7f7a18156` | There are terms and conditions that\ \ need to be acknowledged before continuing. |\n\n```\n{\n \"error\": {\n \ \ \"errors\": [\n {\n \"property\": \"[campaigns][0]\",\n \"\ message\": \"You do not have \\\"view\\\" access on this entity.\",\n \"\ code\": \"16bd7f4a-bf84-45c3-aa95-9b32aeb139b0\",\n \"type\": \"unauthorised\"\ \n }\n ],\n \"code\": \"403\",\n \"message\": \"Forbidden\"\n }\n\ }\n```\n\n### Not Found (Code 404)\nIf there is an error locating a requested\ \ resource, you’ll receive a “404 Not Found\" http response. The body of the response\ \ will be JSON with the `errors` attribute containing an array of details of the\ \ error(s).\n\n| Code | Description |\n|--|--|\n| `0d528fb3-569c-45fa-b2b5-309b360bf9fa`\ \ | A route has not been found to match the supplied URL. |\n\n**Sample JSON response\ \ body when an invalid URL has been requested.**\n```\n{\n \"error\": {\n \ \ \"errors\": [\n {\n \"property\": \"\",\n \"message\": \"\ No route found for \\\"POST \\/foo\\\"\",\n \"code\": \"0d528fb3-569c-45fa-b2b5-309b360bf9fa\"\ ,\n \"type\": \"not_found\"\n }\n ],\n \"message\": \"Not Found\"\ ,\n \"code\": \"404\"\n }\n}\n```\n\n### Method Not Allowed (Code 405)\nIf\ \ there is an error accessing a resource using the given HTTP verb, you’ll receive\ \ a “405 Method Not Allowed“ http response. The body of the response will be JSON\ \ with the `errors` attribute containing an array of details of the error(s).\n\ \n| Code | Description |\n|--|--|\n| `5fe5c44b-f299-4fa6-bda4-bf80fecf6093` |\ \ A route has been found which matches the supplied URL but cannot be accessed\ \ via the HTTP verb. |\n\n**Sample JSON response body when an valid URL has been\ \ requested with an invalid request method.**\n```\n{\n \"error\": {\n \"\ errors\": [\n {\n \"property\": \"\",\n \"message\": \"No route\ \ found for \\\"POST \\/foo\\\": Method Not Allowed (Allow: GET)\",\n \"\ code\": \"5fe5c44b-f299-4fa6-bda4-bf80fecf6093\",\n \"type\": \"routing_error\"\ \n }\n ],\n \"message\": \"Method Not Allowed\",\n \"code\": \"\ 405\"\n }\n}\n```\n\n### Too Many Requests (Code 429)\nThis error code indicates\ \ that too many requests were sent within a period of time. See [Rate limits](#section/Common-API-Conventions/Rate-Limits)\ \ for more information on this.\n\n\n**Sample JSON response body when a rate limit\ \ is hit.**\n```\n {\n \"error\": {\n \"errors\": [\n \ \ {\n \"property\": \"\",\n \"message\": \"You have made\ \ too many requests recently, please try again later.\",\n \"code\"\ : \"3b22ff00-96a5-4fa4-96cc-f36e68dbd2e2\",\n \"type\": \"too_many_requests\"\ \n }\n ],\n \"message\": \"Too Many Requests\",\n \ \ \"code\": \"429\"\n }\n }\n ``` \n\n### Internal System Error (Code\ \ 500)\nIf there is an internal error, you’ll receive a “500 Internal Server Error“\ \ http response. The body of the response will be JSON with the `errors` attribute\ \ containing an array of details of the error(s).\n\n| Code | Description |\n\ |--|--|\n| `a72717b1-0ecb-4d74-a77f-3e3702a2c8d5` | A non-specific error has occured.\ \ |\n| `c2b63ca9-e15b-48ee-bcf0-0469a2f52047` | A connection to a remote service\ \ could not be established, this could be related to an outage or an invalid request.\ \ |\n| `03b1fdbe-ce8a-4de7-b850-b5e4bccf7f81` | A remote service encountered an\ \ error, this could be related to an outage or an invalid request. |\n\n## Date\ \ Time\n\n`v3` API endpoints use [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)\ \ date time format.\n\n### Example:\n\n`2019-03-01T12:01:00+00:00` - this example\ \ represents 1 minute past midday on the 1st of March 2019 in UTC.\n\n`2019-03-01`\ \ - date only example\n" contact: email: support@partnerize.com x-logo: url: https://console.partnerize.com/assets/img/network/partnerize/logo.png altText: Partnerize servers: - description: Production url: https://api.partnerize.com - description: Local url: http://api.partnerize.tech tags: - description: 'All API calls are contextual to the User that is making the request, and all User accounts are associated with the Network that they are created on. Each network has a unique `application_user_key`.' name: Networks - description: 'A Brand can view all Partners who are created on their network. This endpoint is not specific to a Campaign, therefore it pools all available Partners who have been created or are able to access their Network. ​ It is also possible to accept new Partners onto the Network, or to reject any approved or pending Partners from the Network. If a Partners is rejected from the Network, they will be automatically rejected from all participating Campaigns.' name: Network Partners - description: Terms and conditions endpoint that returns terms and conditions that must be accepted by a partner to join the network. name: Network Terms and Conditions - description: A Campaign is owned by a Brand and a Brand may have multiple Campaigns. A Campaign represents an entity which the Brand uses to represent something that they wish to allow Partners the chance to promote. A Campaign dictates what products/events/conversions can be promoted, and lets the Partners understand what Commission they would earn for generating sales/events/conversions. The Brand has complete control over their Campaigns and dictates which Partners they accept onto the Campaign to promote their services. name: Campaigns - description: 'A User can create one or more Brand accounts. A User can also have access to one or more Brand accounts - this is determined by the User''s permissions. A Network admin may choose to grant a User access to multiple entities within their Network.' name: Brands - description: 'Before Partners can generate conversions for a Campaign, they must be approved to do so. A Partner can apply to be part of a Campaign, or the Brand can choose to add the Partner(s) of their choice to their own Campaign. Furthermore, if a Brand has stipulated their own unique set of Campaign Terms and Conditions, the Partner must explicitly agree to these if they are to be fully approved on the Campaign.' name: Participating Partners - description: A Voucher references a coupon code, or voucher code which the Brand offers to their customers to usually perform a price discount at the end of the transaction. Specific rules can be set to defined Vouchers ensuring that only valid codes can be used and can also be restricted to specific Partners. name: Voucher Codes - description: 'A Brand may wish to offer pre-generated _Creative_ so that the Partners can advertise the Brand easily. It is possible to categorise Creative with tags and there are 3 distinct Creative formats: Image, HTML and Text. Brands can organise their Creatives in a flexible structure by using _Creative Tags_.' name: Creatives - description: 'A Brand may want to offer a selection of Product Feeds to their Partners on a specific Campaign. When a Product Feed is created, it will be periodically downloaded and parsed for all Partners who participate on the Campaign to ensure their tracking links are inserted for all anchor links within the Product Feed. Any text based file format is supported.' name: Product Feeds - description: 'Based on all tracked events, a real-time cache of currencies and non standard conversion and conversion item attributes are kept for all Campaigns and Partners. This endpoint can be used to determine what non standard data might appear in reports/exports and is also useful when building an external app which will display Conversion data.' name: Meta Attributes - description: A Brand may want to offer a specific Deal to Partners on a specific Campaign. These Deals represent a timed promotion which can be programmatically ingested into the Partner's platform and offered dynamically to their user base. name: Deals - description: 'Transaction Queries (TQs) allow Partners to raise disputes about conversions with a Brand. There are three types of Transaction Queries: - Untracked: A conversion has not been tracked. - Incorrect Commission: A conversion does not have the correct Partner commission value. - Declined: The Brand has rejected a conversion.' name: Campaign Transaction Queries - description: So that Brands can receive payment for all approved conversion events they have generated across a Brand's Campaigns, the Brand must raise an Invoice and send payment to Partnerize. Once the payment has cleared, all funds will be deposited into the relevant Partner accounts. name: Invoices - description: Reporting Meta is functionality that allows Brands to generate reports based on specific meta data. name: Reporting on Meta data - name: Attribution description: 'Note: Attribution is a limited availability BETA feature. Attribution features allow you to control who the transaction is attributed to, based on the the configured rules. To process attribution rules we analyse clicks within the click trail going back the length of the cookie period for the campaign.' - name: Suppressed Code description: Suppressed codes are assigned to a campaign. If a suppressed code is matched, the sale is no longer rewarded - even if there are supporting clicks. - name: Exclusive Code description: Exclusive codes are assigned to a partner. If a partner’s exclusive code is redeemed, the partner wins the sale - even if they don’t contribute any clicks. - name: Preferred Partner description: Campaigns can have one preferred partner at any time. A sale will be attributed to a preferred partner if they contribute any clicks to that sale. - name: In-Cart description: Define a period leading up to the time of purchase where clicks will be ignored and not attributed with a commission. Helps prevent last-click poaching. - name: Split description: Split all CPA commissions between the initiator (first click), contributors (supporting click) and convertor (last click) in the click chain. - name: Commissions description: Commissions - name: Commissions CSV Download description: Commissions CSV Download - name: Promotional Commissions description: Promotional Commission Endpoints - name: Voucher Commissions description: Voucher Commission Endpoints - name: Tiers description: Commission Tiers Endpoints - name: Partner Commissions description: Partner Commissions Endpoints - name: Meta Fields description: Meta Fields Endpoints - name: Saved Reports description: Manage sets of filters for reporting. Those can be saved for either a single campaign or a campaign group. - name: Fraud description: Endpoints for handling fraud incidents reports from data science. - name: Custom Terms and Conditions description: Manage partner specific terms and conditions. You can use this group of endpoints to create custom terms and conditions for certain partners. - name: Partner Groups description: A Campaign owner can organise Partners into Partner Groups, also known as Commission Groups. These Groups can be used for Reporting purposes, Commission offers and Voucher Code allocation. - name: Campaign Group Campaigns description: Campaigns can be grouped together. - name: Partnerize Tags description: Partnerize Tags allow the creation, management and automated serving of various Partnerize features into websites.

All generated Partnerize Tags include a `url` of which can be embedded into websites to serve back the enabled features of that tag in JavaScript content.

Partnerize Tags only need to be integrated once, allowing features of the tag to be updated at any time using the Partnerize Tags APIs.

To view available features of the Partnerize Tag, use the [List Partnerize Tag Features](#operation/listPartnerizeTagFeatures) API. - name: Partnerize Tag Features description: Partnerize Tag features are what power the Partnerize Tag, delivering Partnerize functionality to websites through the Partnerize Tag.

Partnerize Tag Features come in all shapes and sizes depending on the intended use case.

To find out more about Partnerize Tag Features and how they can be used, head over to the [Partnerize Help Hub](https://help.phgsupport.com/hc/en-us). - name: Clicks description: Endpoints for analysing click data - name: Impressions description: Endpoints for analysing impression data - name: Conversions description: Endpoints for analysing conversion data - name: Key Performance Indicators description: A measurable value that demonstrates how effectively a client is achieving key business objectives within their affiliate program. Key performance indicators are used to evaluate success at reaching goals. - name: Tutorials description: "This section contains tutorials to serve as a good jumping-off point\ \ on how to do basic queries against the Analytics API. If you have any feedback\ \ or think it would be useful to provide more examples, please reach out and let\ \ us know.\n\n\n## Getting single top level metrics for multiple campaigns.\n\n\ Let's say for example, that you wish to get the Total Conversions Items and Total\ \ Partner Commission in GBP; this can be achieved by using the Conversion Count\ \ Endpoint to retrieve single count metrics.\n\nThis can be done by using the\ \ `/v3/brand/analytics/conversions/count` endpoint.\n\n\nSpecify the following\ \ metrics:\n\n```\n{\n \"metrics\":[\n \"total_conversion_items\",\n \ \ \"total_partner_commission\"\n ]\n}\n```\n\n\nSpecify the date time range:\ \ \n\n\n```\n{\n \"date_time_ranges\":[\n {\n \"start\":\"2020-10-01T00:00:00\"\ ,\n \"end\":\"2020-12-31T23:59:59\"\n }\n ],\n \"metrics\":[\n\ \ \"total_conversion_items\", \"total_partner_commission\"\n ]\n}\n```\n\ \nThen specify the output currency:\n\n```\n{\n \"date_time_ranges\":[\n \ \ {\n \"start\":\"2020-10-01T00:00:00\",\n \"end\":\"2020-12-31T23:59:59\"\ \n }\n ],\n \"metrics\":[\n \"total_conversion_items\", \"total_partner_commission\"\ \n ],\n \"output_currency\": \"GBP\"\n}\n```\n\n\nFinally, specify the Campaign\ \ IDs:\n\n\n```\n{\n \"scope\":{\n \"campaigns\":[\n \"campaign_id_1\"\ ,\n \"campaign_id_2\"\n ]\n },\n \"date_time_ranges\":[\n \ \ {\n \"start\":\"2020-10-31T00:00:00\",\n \"end\":\"2020-10-31T23:59:59\"\ \n },\n {\n \"start\":\"2020-12-25T00:00:00\",\n \"\ end\":\"2020-12-25T23:59:59\"\n }\n ],\n \"metrics\":[\n \"total_conversions\"\ , \"total_conversion_items\"\n ],\n \"output_currency\": \"GBP\"\n}\n```\n\ \n\nThe result will look like this:\n\n```\n{\n \"data\":{\n \"total_conversion_items\"\ :235,\n \"total_partner_commission\":1200.50\n }\n}\n```\n\n\n## Get the\ \ total Conversion Order Value, Commission Broken Down by Campaign, Country and\ \ Currency.\n\nLet's say for example you want to see the total order value and\ \ commission broken down by campaign, country and currency and sorted by the total\ \ commission, which in tabular format looks like:\n\n```\n+-------------+---------------+---------+----------------+----------+-------------------+------------------+\n\ | campaign_id | campaign_name | country | country_name | currency | total_order_value\ \ | total_commission |\n| | | | \ \ | | | |\n+-------------+---------------+---------+----------------+----------+-------------------+------------------+\n\ | 1 | Japan | JP | Japan | JPY | 500.00 \ \ | 123.12 |\n+-------------+---------------+---------+----------------+----------+-------------------+------------------+\n\ | 1 | Japan | GB | United Kingdom | USD | 400.00 \ \ | 50.12 |\n+-------------+---------------+---------+----------------+----------+-------------------+------------------+\n\ | 2 | US | US | United States | USD | 350.00 \ \ | 31.33 |\n+-------------+---------------+---------+----------------+----------+-------------------+------------------+\n\ | 3 | Italy | IT | Italy | EUR | 100.00 \ \ | 9.01 |\n+-------------+---------------+---------+----------------+----------+-------------------+------------------+\n\ ```\n\n\nTo do this you can use the `/brand/analytics/conversions/explode` endpoint\ \ like in the previous example above.\n\n\nUsing the example JSON body from above\ \ this would look like:\n\n```\n{\n \"metrics\":[\n \"total_order_value\"\ ,\n \"total_commission\"\n ],\n \"group_by\":[\n \"campaign\",\n\ \ \"country\",\n \"currency\"\n ],\n \"order_by\":[\n {\n \ \ \"field\":\"total_commission\",\n \"direction\":\"DESCENDING\"\ \n }\n ],\n \"top\":10,\n \"scope\":{\n \"campaigns\":[\n \ \ \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\"\ \n ]\n },\n \"date_time_ranges\":[\n {\n \"start\":\"2019-01-01T00:00:00\"\ ,\n \"end\":\"2019-12-31T23:59:59\"\n }\n ]\n}\n```\n\nand a response\ \ should look like the following:\n\n```\n{\n \"data\":[\n {\n \ \ \"campaign_id\":\"11111l63\",\n \"campaign_name\":\"Campaign 1\",\n\ \ \"currency\": \"GBP\",\n \"country\": \"US\",\n \"total_order_value\"\ :1000,\n \"total_commission\":1000,\n },\n {\n \"campaign_id\"\ :\"11111l65\",\n \"campaign_name\":\"Campaign 2\",\n \"currency\"\ : \"USD\",\n \"country\": \"IT\",\n \"total_order_value\":1000,\n\ \ \"total_commission\":1000,\n },\n ]\n}\n```\n\n## Get the Total\ \ Partner Commision for approved and pending Converison broken down by Partner\ \ and Conversion Status\n\nLet's say you want to see the total partner commission\ \ broken down by partner and conversion status ordered by total partner commission\ \ where the conversions are approved or pending which in tabular format looks\ \ like:\n\nTo do this you can use the `/v3/brand/analytics/conversions/explode`\ \ endpoint like in the previous example above.\n\n\n```\n+------------+--------------+----------+--------------------------+\n\ | partner_id | partner_name | status | total_partner_commission |\n| \ \ | | | |\n+------------+--------------+----------+--------------------------+\n\ | 1 | Partner 1 | pending | 200.00 |\n+------------+--------------+----------+--------------------------+\n\ | 1 | Partner 1 | approved | 150.00 |\n| \ \ | | | |\n| | \ \ | | |\n+------------+--------------+----------+--------------------------+\n\ | 2 | Partner 2 | pending | 350.00 |\n+------------+--------------+----------+--------------------------+\n\ | 2 | Partner 2 | approved | 100.00 |\n+------------+--------------+----------+--------------------------+\n\ ``` \n\nTo do the filtering it requires a `filter_by` property:\n\n```\n\"filter_by\"\ :[\n {\n \"field\":\"conversion_status\",\n \"operator\":\"EQUALS\",\n\ \ \"value\":[\n \"approved\",\n \"pending\"\n ]\n }\n]\n\ ```\n\n\nThe full request body would look like as follows:\n\n\n```\n{\n \"\ metrics\":[\n \"total_partner_commission\"\n ],\n \"group_by\":[\n \ \ \"partner\",\n \"conversion_status\"\n ],\n \"order_by\":[\n \ \ {\n \"field\":\"total_partner_commission\",\n \"direction\"\ :\"DESCENDING\"\n }\n ],\n \"top\":10,\n \"scope\":{\n \"campaigns\"\ :[\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \ \ \"5\"\n ]\n },\n \"filter_by\":[\n {\n \"field\":\"\ conversion_status\",\n \"operator\":\"EQUALS\",\n \"value\":[\n\ \ \"approved\",\n \"pending\"\n ]\n }\n ],\n\ \ \"date_time_ranges\":[\n {\n \"start\":\"2019-01-01T00:00:00\"\ ,\n \"end\":\"2019-12-31T23:59:59\"\n }\n ]\n}\n```\n\n## Get the\ \ total of number of clicks broken down by Campaign and day for all countries\ \ except the US\n\nLet's say you want to see the total number of clicks across\ \ your campaigns, broken down by day for all countries except the US, in a tabular\ \ format this looks like the following:\n\n\nTo do this you can use the `/v3/brand/analytics/clicks/explode`\ \ endpoint.\n\n\n```\n+---------------------------+-------------+---------------+---------+----------------+--------------+\n\ | date_time | campaign_id | campaign_name | country | country_name\ \ | total_clicks |\n| | | \ \ | | | |\n+---------------------------+-------------+---------------+---------+----------------+--------------+\n\ | 2020-03-02T00:00:00+02:00 | 1 | Campaign 1 | JP | Japan \ \ | 2000 |\n+---------------------------+-------------+---------------+---------+----------------+--------------+\n\ | 2020-03-02T00:00:00+02:00 | 1 | Campaign 2 | IT | Italy \ \ | 1000 |\n+---------------------------+-------------+---------------+---------+----------------+--------------+\n\ | 2020-03-03T00:00:00+02:00 | 1 | Campaign 2 | GB | United Kingdom\ \ | 500 |\n+---------------------------+-------------+---------------+---------+----------------+--------------+\n\ | 2020-03-03T00:00:00+02:00 | 1 | Campaign 4 | DE | Germany\ \ | 250 |\n+---------------------------+-------------+---------------+---------+----------------+--------------+\n\ ```\n\n\nTo group it by day you need to set the `interval` - this is in [ISO 8601\ \ duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) format. For example,\ \ one day is `P1D`, or if you want it by month `P1M` or even hourly `PT1H`.\n\n\ The request body would look the following: - note the `not` property in `filter_by`.\ \ This is the equivalent of saying `NOT EQUAL`\n\n\n```\n{\n \"metrics\":[\n\ \ \"total_clicks\"\n ],\n \"group_by\":[\n \"date_time\",\n \ \ \"campaign\",\n \"country\"\n ],\n \"order_by\":[\n {\n \ \ \"field\":\"total_clicks\",\n \"direction\":\"DESCENDING\"\n \ \ }\n ],\n \"top\":10,\n \"scope\":{\n \"campaigns\":[\n \"\ 1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\"\n \ \ ]\n },\n \"filter_by\":[\n {\n \"field\":\"country\",\n \ \ \"operator\":\"EQUALS\",\n \"value\":[\n \"US\"\n \ \ ],\n \"not\": true\n }\n ],\n \"interval\": {\n \ \ \"field\": \"date_time\",\n \"period\": \"P1D\"\n },\n \"date_time_ranges\"\ :[\n {\n \"start\":\"2019-01-01T00:00:00\",\n \"end\":\"\ 2019-12-31T23:59:59\"\n }\n ]\n}\n```\n\nIt's essential to understand that\ \ Explode does not support zero filling - so if there isn't data for particular\ \ interval it will not be returned in the response, to use zero filling then please\ \ use the Time Series endpoint. Furthermore, if you don't need to group by multiple\ \ dimensions, then we recommend using the TimeSeries endpoint, which is much faster\ \ and costs less rate-limiting tokens. See the tutorial below for an example.\ \ Note when grouping by date using the explode endpoint you don't get a `start_date`\ \ and `end_date` like the TimeSeries endpoint.\n\n\n## Using the TimeSeries endpoint\ \ to show the total conversion items and commission over time\n\nAs previously\ \ mentioned above, the time-series endpoint is much more performant, and the query\ \ cost will be less. Let's say you want to render a chart, and want to plot over\ \ a week in daily intervals how many conversion items have been tracked along\ \ with the commission. The `timeseries` endpoint will return data grouped by a\ \ specified date interval. It also supports zero filling - so if there isn't data\ \ for a particular interval, the metrics will be set to zero. This is why this\ \ endpoint is useful for driving charts and graphs. Again, we highly recommend\ \ this over using the Explode endpoint.\n\nUse the POST method on the URI `/v3/brand/analytics/conversions/timeseries`.\n\ \nWith the request body of: \n\n```\n{\n \"metrics\":[\n \"total_conversion_items\"\ ,\n \"total_commission\"\n ],\n \"output_currency\":\"GBP\",\n \"interval\"\ :{\n \"period\":\"P1D\"\n },\n \"scope\":{\n \"campaigns\":[\n \ \ \"1\",\n \"2\"\n ]\n },\n \"date_time_ranges\":[\n \ \ {\n \"start\":\"2019-01-01T00:00:00\",\n \"end\":\"2019-12-31T23:59:59\"\ \n }\n ]\n}\n```\n\nThe endpoint result would look like:\n\n\n```\n{\n\ \ \"data\": [\n {\n \"date_time_range\": {\n \"start\": \"2020-03-01T00:00:00+00:00\"\ ,\n \"end\": \"2020-03-02T00:00:00+00:00\"\n },\n \"total_conversions\"\ : 151,\n \"total_order_value\": 34300.311980922306\n },\n {\n \ \ \"date_time_range\": {\n \"start\": \"2020-03-02T00:00:00+00:00\",\n\ \ \"end\": \"2020-03-03T00:00:00+00:00\"\n },\n \"total_conversion_items\"\ : 145,\n \"total_commission\": 45835.76083435612\n }\n}\n```\n\nA notable\ \ difference is that for TimeSeries you get a start and end date in the response\ \ body unlike the Explode endpoint when grouping by date. " - name: Introduction description: "The Analytics API provides access to our Analytical Data Platform;\ \ it has an expressive easy to use request structure that allows you to write\ \ fluent queries to access your data. There is up to 1000x speed improvement for\ \ specific queries and operations compared to the legacy Reporting (v1) API and\ \ allows for more in-depth insight into your data. The Analytics API also powers\ \ the Analytics Reporting UI.\n\nThe below covers the core concepts of the Analytics\ \ API, head over to the [Tutorials](#tag/Tutorials) section for more examples.\n\ \n## Metrics and Dimensions \n\nAnalytics has two common data types `Dimension`\ \ and `Metric`. Metrics are the quantitative measurements of data and dimensions\ \ are the labels used to describe them—or, in even easier terms: numeric values\ \ always express metrics while non-numerical values express dimensions. An example\ \ in the context of Analytics, `total_clicks` would be a metric and `country`\ \ would be a dimension, an in-depth explanation into each is below.\n\n\n### Metrics\n\ \nAll endpoints allow you to return one or more metrics, except for the `filter`\ \ endpoint, which will only return metrics if you sort by a metric.\n\n\nYou can\ \ supply a single metric:\n\n```\n\"metrics\": [\"total_clicks\"]\n\n```\n\nOr\ \ multiple metrics:\n\n```\n\"metrics\": [\"total_clicks\", \"total_clicks_converted\"\ ]\n\n```\nYou should request multiple metrics in one request rather than making\ \ multiple requests where possible. The metrics will be returned in the response\ \ object in the same casing they are supplied.\n\n\n#### Metric Approximation\n\ \nFor performance reasons, we apply approximations by default to a small set of\ \ metric types; this is similar to how Google Analytics uses sampling techniques\ \ for aggregated metrics to improve performance.\n\nCurrently, approximations\ \ are applied to the Click Metrics; the metrics that are approximated are `total_unique_clicks`.\ \ Furthermore, you'll be able to identify which metrics are approximated by looking\ \ at the `X-Approximate-Metrics` response header.\n\nAll financial metrics, such\ \ as `total_commission` and `total_partner_commission` are never approximated.\n\ \n\n\n### Dimensions\n\nAs mentioned above, a dimension is a non-numeric value.\ \ All endpoints support the ability to filter by a dimension, see the \"Filtering\"\ \ section below. The \"Explode\" and \"Filter\" endpoints support the ability\ \ to return the dimension values. \n\n## Data Sources and Endpoint Types\n\nIn\ \ Analytics there are three datasources:\n\n1. Clicks\n2. Conversions - Including\ \ Conversion Items\n3. Impressions\n\n\nand there are 4 endpoint types:\n\n1.\ \ Count\n2. Explode\n3. Timeseries\n4. Filter\n\n\n### Count \n\nA count endpoint\ \ can return one or multiple metrics, useful to present top-level figures used\ \ on Dashboards, for example.\n\n### Explode\n\nThe explode endpoint returns metrics\ \ grouped either by date or multiple dimensions (see the [Tutorials](#tag/Tutorials)\ \ for an example). It's called explode as it's 'Exploding' the data out, using\ \ a tabular format as an example it allows for grouping the data like the following:\n\ \n\n```\n+-------------+---------------+---------+----------+-------------------+------------------+\n\ | campaign_id | campaign_name | country | currency | total_order_value | total_commission\ \ |\n+-------------+---------------+---------+----------+-------------------+------------------+\n\ | 1 | Japan | JP | JPY | 500 | 120.31\ \ |\n+-------------+---------------+---------+----------+-------------------+------------------+\n\ | 2 | Japan | GB | USD | 400 | 50.12\ \ |\n+-------------+---------------+---------+----------+-------------------+------------------+\n\ | 3 | US | US | USD | 300 | 31.13\ \ |\n+-------------+---------------+---------+----------+-------------------+------------------+\n\ | 4 | Italy | IT | EUR | 200 | 90.00\ \ |\n+-------------+---------------+---------+----------+-------------------+------------------+\n\ ```\n\nNote that the explode endpoint doesn't support zero filling, meaning that\ \ if there is no data for a particular record it will be excluded from the resulting\ \ response instead of being included with zero values. \n\n### Timeseries\n\n\ The Time series endpoints allow you to obtain metrics over intervals in time and\ \ ordered chronologically. Timeseries calls are performant and are great for powering\ \ plot style charts. One or multiple metrics can be requested with time series;\ \ however, it can only ever be grouped by a date-time. \n\n### URI Structures\n\ \ \nThe data source to use is embedded the the URI, with the following format:\n\ \n```\n/v3/brand/analytics//\n```\n\nFor example, the URI\ \ for using `explode` on the `conversions` data source would be:\n\n```\n/v3/brand/analytics/conversions/explode\n\ ```\n\nIt isn't possible to retrieve data belonging to multiple data sources in\ \ one endpoint call. So for example, to get the total number of clicks and the\ \ total number of conversions, two API calls will need to be made to both the\ \ `conversion` and `click` data sources.\n\n## Explode - Group By Dimension Response\ \ Values\n\nWhen using the Explode Endpoint and grouping by particular dimensions\ \ in some instances, you will be returned both an `_id` and `_name` for the dimension,\ \ while others return only the dimension. See the full list of return properties\ \ below:\n\n\n| Dimension | Return Properties \ \ |\n|----------------------|----------------------------------------------|\n\ | advertiser_reference | advertiser_reference |\n| browser_family\ \ | browser_family |\n| browser_major \ \ | browser_major |\n| browser_minor \ \ | browser_minor |\n| browser_patch | browser_patch\ \ |\n| campaign | campaign_id, campaign_name\ \ |\n| category | category \ \ |\n| conversion_metric | conversion_metric_id, conversion_metric_name\ \ |\n| conversion_reference | conversion_reference |\n\ | conversion_status | conversion_status |\n| conversion_type\ \ | conversion_type_id, conversion_type_name |\n| country \ \ | country |\n| currency |\ \ currency |\n| customer_type | customer_type\ \ |\n| date_time | date_time \ \ |\n| device | device_id, device_name\ \ |\n| os_family | os_family \ \ |\n| os_major | os_major \ \ |\n| os_minor | os_minor \ \ |\n| os_patch | os_patch \ \ |\n| partner | partner_id, partner_name \ \ |\n| partnership_model | partnership_model_id, partnership_model_name\ \ |\n| sku | sku |\n\ | traffic_source | traffic_source_id, traffic_source_name |\n| type\ \ | type |\n| user_context\ \ | user_context_id, user_context_name |\n| voucher_code \ \ | voucher_code |\n| voucher_status \ \ | voucher_status |\n\n\n## Request Structure\n\ \nThis section outlines the commonality of the request structures between all\ \ endpoints.\n\n\n### Scope\n\nA scope is used to specify the `campaign` ID's\ \ that you wish to filter by. \n\n\n```\n\"scope\": {\n \"campaigns\": [\"1\"\ , \"2\"],\n}\n\n```\n\nThe example above will first check you have access to campaign\ \ ID's `1` and `2`. If you do have access, you will receive results for those\ \ two campaigns.\n\nIf you do not have access to one or more requested `campaigns`\ \ you will receive a `403 Forbidden` response.\n\nPlease see the [Tutorials](#tag/Tutorials)\ \ section for an example of how to filter by partners.\n\n### Date Time Ranges\n\ \nFor each call, you are required to provide a date-time range. You can specify\ \ multiple date ranges if you like which operate on an `_OR_` basis, rather than\ \ an `_AND_` basis.\n\nYou can specify a single range:\n\n```\n\"date_time_ranges\"\ : [\n {\n \"start\": \"2020-10-0T00:00:00\",\n \"end\": \"2020-10-31T23:59:59\"\ \n }\n]\n```\n\nAlternatively, you could specify multiple ranges; this example\ \ would give you results for Black Fridays for the past three years:\n\n```\n\ ...\n\"date_time_ranges\": [\n {\n \"start\": \"2017-11-24T00:00:00\",\n \ \ \"end\": \"2017-11-24T23:59:59\"\n },\n {\n \"start\": \"2018-11-23T00:00:00\"\ ,\n \"end\": \"2018-11-23T23:59:59\"\n },\n {\n \"start\": \"2019-11-29T00:00:00\"\ ,\n \"end\": \"2019-11-29T23:59:59\"\n }\n]\n...\n```\n\n### Top\n\nThe `top`\ \ property is used to limit the number of results. If not specified it defaults\ \ to `10000` results and there is an upper limit of `50000`.\n`10000` should be\ \ sufficient to group your data day, publisher and campaign over one month.\n\n\ ### Filtering\n\nThe API supports filtering by multiple dimensions supporting\ \ multiple operations. Filters operate on the `_AND_` basis and can be compounded.\ \ \n\nThe below is an example filtering conversions where the device is a desktop\ \ `AND` the country is `EQUAL` to US `AND` the currency is `NOT EQUAL` to GBP.\n\ \n```\n\n\"filter_by\": [\n {\n \"field\": \"device_id\",\n \"value\":\ \ \"2\"\n },\n {\n \"field\": \"country\",\n \"value\": \"US\"\n }\n\ \ {\n \"field\": \"currency\",\n \"value\": \"GBP\",\n \"not\": true\n\ \ }\n]\n```\n\n\nCurrently filtering by metrics is not yet supported.\n\n####\ \ Property Filter Values\n\n##### Reference Endpoints\n\nBelow is a map of the\ \ properties that have reference endpoints. You can use these to find the available\ \ values to filter by.\n\n\n| Name | Reference Endpoint \ \ |\n|----------------------|----------------------------------------------------------|\n\ | conversion_metric_id | [/reference/conversion_metric/](#tag/Conversion-Metrics)\ \ |\n| conversion_type_id | [/reference/conversion_type/](#tag/Conversion-Types)\ \ |\n| country | [/reference/country/](#tag/Countries) \ \ |\n| currency | [/reference/currency/](#tag/Countries)\ \ |\n| device_id | [/reference/devices/](#tag/Devices)\ \ |\n| partnership_model_id | [/reference/partnership_model/](#tag/Partnership-Models)\ \ |\n| traffic_source_id | [/reference/traffic_source/](#tag/Traffic-Sources)\ \ |\n| user_context_id | [/reference/user_context/](#tag/User-Contexts)\ \ |\n\n\n##### Other\n\nBelow is a map of available values to filter\ \ by for properties that *do* not have reference endpoints.\n\n###### `conversion_status`\n\ \n```\napproved\npending\nrejected\n```\n\n###### `voucher_status`\n\n```\nexpired\n\ ignored\ninvalid\nunknown\nvalid\n```\n\n\n### Timezones\n\nYou can set the timezone\ \ by using the `timezone` property. The list of supported timezones can be found\ \ using the reference API endpoint; see [/reference/timezone/](#tag/Timezones).\n\ \n\n```\n\"timezone\": \"CET\"\n\n```\n\n\nYou should see this timezone reflected\ \ in the offset of the date-times in the response whenever you group by date,\ \ or use the `time-series` endpoint.\n\n\n```\n{\n \"date\": \"2020-04-03T00:00:00+02:00\"\ ,\n}\n```\n\nTimezone offsets such as `2020-05-01T00:00:00+02:00` will be ignored\ \ and the `timezone` property must be used instead.\n\n\n### Custom Request and\ \ Response Headers\n\n| Name | Type | Description \ \ \ \ \ \ |\n|-----------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\ | X-Total-Row-Count | Response | Returns the total number of rows for the\ \ given request, used within the context of the Explode endpoint. This has to\ \ be requested in the JSON body of the request setting `include_total_row_count`\ \ to `true` |\n| X-Approximate-Metrics | Response | Returns a list of metrics\ \ that are approximated - see the Metric Approximation section above. \ \ \ \ |\n\n\n \n## Currency Conversion\n\nIf you ask\ \ for a currency based metric, `total_order_value`, for example, you should also\ \ specify an `output_currency` using the ISO 4217 format. If you don't provide\ \ an output currency, it will default to `USD`. Currently, the API only supports\ \ one currency output per request. The list of supported currencies can be found\ \ using the reference API endpoint; see [/reference/currencies/](/#tag/Currencies).\n\ \n\n```\n\"output_currency\": \"GBP\"\n```\n\nThe exchange rate used is the exchange\ \ rate for the given day of the API call. This means that between day to day usage,\ \ you will experience fluctuations in the financial totals due to changing exchange\ \ rates.\n\n\n## Rate-limiting\n\nTo ensure the reliability of our Analytics Platform\ \ and to ensure it remains stable for all our clients, the Analytics API is rate-limited.\ \ Analytics API uses its own rate-limiting algorithm and allowance, which is separate\ \ from the rest of the Partnerize API endpoints. Its rate-limiting error responses\ \ are the same as the standard error response for v3 endpoints. See the [Rate\ \ Limits](#section/Common-API-Conventions/Rate-Limits) section for details.\n\n\ The query costs are calculated based upon the endpoint and the date-time range\ \ that is requested. The breakdown of these is shown below.\n\n| Date Range |\ \ Explode | Count | Time Series | Filter |\n|------------|---------|-------|-------------|--------|\n\ | < 1 Year | 3 | 2 | 2 | 3 |\n| 1+ Year | 5 \ \ | 3 | 3 | 5 |\n| 2+ Year | 10 | 4 | 4 \ \ | 6 |\n| 3+ year | 12 | 5 | 5 | 7 |\n|\ \ 4+ year | 15 | 6 | 6 | 8 |\n\n\n\nAs an example,\ \ if you are requesting 2+ years of data from the Explode endpoint that would\ \ allow you to make a total of 6 API calls over a period of 60 seconds.\n\n**Rate\ \ Limits costs and quotas are continually reviewed. These can either increased\ \ or decreased based upon the following criteria, the volume of data for your\ \ account, to ensure platform stability or to accommodate functionality changes\ \ within the API. We, therefore, recommend that your code has the appropriate\ \ error handling and logging to accommodate for such changes.**\n\n\n### Recommendations\n\ \nTo avoid being throttled, it's best to design your API integration using best\ \ practices:\n\n- Only request the data that your integration requires.\n- Implement\ \ caching for data that your integration uses often.\n- Ensure that your code\ \ has appropriate error handling and respecting the `X-RateLimit-Retry-After`\ \ header to ensure your code doesn't keep trying to make requests.\n- Modulate\ \ the rate of requests, whilst the API caters for bursty traffic, respecting the\ \ request limits will increase the stability of your integration.\n" - name: Current User description: Endpoints for current User - name: Publishers description: Partner management endpoints - name: Exports description: 'Depending on the query parameters, an export request may need to be processed asynchronously. When that happens a background job will be automatically created, and the API response will describe the job rather than the export (see [Jobs v1](#operation/get_job_v1)). If the `complete_email` parameter has been set the export will be sent to the given address once the background job is complete. ' - name: Deep link domains description: 'Endpoints dealing with the management of tracking deep link domains ' x-tagGroups: - name: Networks and Brands Management (v1) tags: - Networks - Network Partners - Network Terms and Conditions - Brands - name: Campaign Management (v1) tags: - Campaigns - Participating Partners - Partner Groups - Custom Terms and Conditions - Voucher Codes - Creatives - Product Feeds - Deals - Meta Attributes - name: Payments (v1) tags: - Campaign Transaction Queries - Transaction Query Reasons - Invoices - name: Commissions (v2) tags: - Commissions - Commissions CSV Download - Promotional Commissions - Voucher Commissions - Tiers - Partner Commissions - Meta Fields - name: Attribution (v2) tags: - Attribution - Suppressed Code - Exclusive Code - Preferred Partner - In-Cart - Split - name: Partner management (v2) tags: - Publishers - Campaign Requests and Invites - Discovery Settings - name: Communications tool (v2) tags: - Communications - Platform Communications - Placeholders - Communication Templates - name: Tracking and Conversions (v3) tags: - Campaign Conversions - Deep link domains - name: Background Jobs (v1) tags: - Jobs (v1) - name: Background Jobs (v3) tags: - Jobs - name: Reporting (v1) tags: - Brand Conversions - Brand Clicks - Exports - Reporting on Meta data - name: Fraud tags: - Incidents - Metrics - Partner Whitelisting - name: Analytics (v3) tags: - Introduction - Tutorials - Clicks - Conversions - Impressions - name: Reference (v1) tags: - Verticals - Locales - Countries - Currencies - Currency countries - Devices - US States - Timezones - Campaign Extra Fields - User Contexts - Traffic Sources - Website Types - Promotional Methods - Conversion Types - Conversion Metrics - Partnership Models - name: Campaigns (v3) tags: - Campaign v3 - name: Partnerize Tags (v3) tags: - Partnerize Tags - Partnerize Tag Features - name: Terms and Conditions (v3) tags: - Network Terms and Conditions (v3) - Network Terms and Conditions Acknowledgments (v3) - name: Commissions (v3) tags: - Commission Groups - Paid Search Violations - name: User (v3) tags: - Current User paths: /network: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: networks: - network: auto_approve_publishers: y cm_client_id: b4d0d85c2cff813cdce092c261b2b200 default_campaign_id: '' network_application_id: '2' network_contact_email: '' network_description: PHG Network network_id: 1l1000003 network_locale: bg network_name: PHG network_notes: Internal PHG Network schema: properties: networks: items: $ref: '#/components/schemas/Network_Wrapper' type: array description: OK tags: - Networks description: Retrieve the details of the authenticated Network. operationId: listNetworks summary: List Networks /user/publisher: post: operationId: createNetworkPartners tags: - Network Partners summary: Create network partner description: Create partners on your network. requestBody: content: application/json: schema: type: object properties: account_name: type: string description: Name of the partner vertical: type: string description: The vertical ID of the partner promotional_method: type: string description: The promotional method ID of the partner signup_ip: type: string description: The signup IP address of the partner entity_terms_id: type: string description: The agreed terms and conditions ID. The ID must be retrieved by retrieving the terms and conditions from the [network terms and conditions API.](#tag/Network-Terms-and-Conditions) network_terms_id: type: string description: The agreed network terms and conditions ID vat_number: type: string description: The VAT number of the partner description: type: string description: Description of the partner company_name: type: string description: Company name associated to the partner operating_country: type: string description: Country of operation for the partner reporting_timezone: type: string description: Reporting timezone of the partner. default_currency: type: string description: Default currency of the partner. phone: type: string description: Phone number of the partner. contact_name: type: string description: The contact name of the partner. contact_email: type: string description: The contact email of the partner. contact_locale: type: string description: The contact ISO locale for the partner. required: - account_name - vertical - promotional_method - signup_ip - entity_terms_id - contact_email responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Publisher_Wrapper' '404': description: Failure content: application/json: schema: properties: publishers: items: $ref: '#/components/schemas/Publisher_Wrapper' type: array type: object /user: post: operationId: createNetworkUserPartners tags: - Network Partners summary: Create network partner with user account description: Create partners on your network with their own Partnerize user account, allowing them to login directly to the Partnerize platform. requestBody: content: application/json: schema: type: object properties: user_name: type: string description: Username of the user email_address: type: string description: Email address of the user password: type: string description: Password of the user address1: type: string description: Address Line 1 of the user postcode: type: string description: Postcode of the user country: type: string description: ISO-2 country code of the user phone: type: string description: Phone number of the user signup_ip: type: string description: The signup IP address of the user firstname: type: string description: The first name of the user lastname: type: string description: The last name of the user address2: type: string description: Address Line 2 of the user address3: type: string description: Address Line 3 of the user address4: type: string description: Address Line 4 of the user locale: type: string description: Locale of the user send_confirm_email: type: boolean description: Send confirmation email to user on successful signup default: false publisher: type: object properties: account_name: type: string description: Name of the partner vertical: type: string description: The vertical ID of the partner promotional_method: type: string description: The promotional method ID of the partner signup_ip: type: string description: The signup IP address of the partner entity_terms_id: type: string description: The agreed terms and conditions ID. The ID must be retrieved by retrieving the terms and conditions from the [network terms and conditions API.](#tag/Network-Terms-and-Conditions) network_terms_id: type: string description: The agreed network terms and conditions ID vat_number: type: string description: The VAT number of the partner description: type: string description: Description of the partner company_name: type: string description: Company name associated to the partner operating_country: type: string description: Country of operation for the partner reporting_timezone: type: string description: Reporting timezone of the partner. default_currency: type: string description: Default currency of the partner. phone: type: string description: Phone number of the partner. contact_name: type: string description: The contact name of the partner. contact_email: type: string description: The contact email of the partner. contact_locale: type: string description: The contact ISO locale for the partner. required: - account_name - vertical - promotional_method - signup_ip - entity_terms_id - contact_email required: - user_name - email_address - password - address1 - postcode - country - phone - signup_ip responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User_Publisher_Wrapper' /network/{network_id}/publisher: get: parameters: - description: ID of the network example: 1l1000003 in: path name: network_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: publishers: - publisher: abn: null account_name: publisher123 campaign_select: null company_division: null company_name: Demo Partner contact_email: demo@performancehorizon.com contact_locale: bg contact_name: John Smith databases: - active: y creation_method: Email database_id: 111111l300347 database_name: Partnerize Test Database female: 50 male: 50 max_age: 77 min_age: 25 publisher_id: 1l1007802 size: 53000 default_currency: GBP description: null foreign_identifier: null gst_registered: null im_provider: Skype im_username: elisangis is_affiliate_user: y is_foreign_network: y is_lead_user: y legal_entity: GB network_id: 1l1000003 network_notes: null network_status: a operating_country: GB phone: 01595725007 phone_area: '+44' promotional_method: 10 promotional_method_name: Portal promotional_countries: - iso: GB name: United Kingdom - iso: US name: United States publisher_id: 1l1007802 reporting_identifier: null reporting_timezone: Australia/Sydney signup_ip: 178.23.129.160 uk_vat_registered: y us_tax_state: null vat_number: 974997534 vertical: 10 vertical_name: Other websites: - active: y primary: n description: Demo Partner website publisher_id: 1l1007802 website_country: GB website_id: 11l18694 website_name: null website_type: 9 website_type_name: PPC website_url: http://www.performancehorizon.com website_vertical: 10 website_vertical_name: Technical week_start: Monday schema: properties: publishers: items: $ref: '#/components/schemas/Publisher_Wrapper' type: array type: object description: OK tags: - Network Partners description: View all Partners on the Network. operationId: listAllPartnersOnTheNetwork summary: List all Partners on the Network post: parameters: - description: ID of the network example: 1l1000003 in: path name: network_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: publishers: - publisher: abn: null account_name: partner123 campaign_select: null company_division: null company_name: Demo Partner contact_email: demo@performancehorizon.com contact_locale: bg contact_name: John Smith databases: - active: y creation_method: Email database_id: 111111l300347 database_name: Partnerize Test Database female: 50 male: 50 max_age: 77 min_age: 25 publisher_id: 1l1007802 size: 53000 default_currency: GBP description: null foreign_identifier: null gst_registered: null im_provider: Skype im_username: elisangis is_affiliate_user: y is_foreign_network: y is_lead_user: y legal_entity: GB network_id: 1l1000003 network_notes: null network_status: a operating_country: GB phone: 01595725007 phone_area: '+44' promotional_method: 10 promotional_method_name: Portal publisher_id: 1l1007802 reporting_identifier: null reporting_timezone: Australia/Sydney signup_ip: 178.23.129.160 uk_vat_registered: y us_tax_state: null vat_number: 974997534 vertical: 10 vertical_name: Other websites: - active: y primary: n description: Demo Partner website publisher_id: 1l1007802 website_country: GB website_id: 11l18694 website_name: null website_type: 9 website_type_name: PPC website_url: http://www.performancehorizon.com website_vertical: 10 website_vertical_name: Technical week_start: Monday schema: properties: publishers: items: $ref: '#/components/schemas/Publisher_Wrapper' type: array type: object description: OK tags: - Network Partners description: Update the `network_status` of a Partner by passing each `publisher_id` along with the relevant `network_status` in an object within a `publishers` array. operationId: updatePartnersNetworkStatus requestBody: content: application/json: schema: example: publishers: - network_status: a publisher_id: 1l1007802 properties: publishers: type: array items: properties: network_status: $ref: '#/components/schemas/Status' publisher_id: description: ID of the partner type: string required: - network_status - publisher_id type: object summary: Update Partner's Network status /reference/terms/{locale}/{country}/{network_id}: get: parameters: - description: Specified locale example: en in: path name: locale required: true schema: $ref: '#/components/schemas/Locale' - description: Specified ISO-2 country code example: GB in: path name: country required: true schema: $ref: '#/components/schemas/Country' - description: ID of the network example: 11l100 in: path name: network_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: terms: - term: locale: bg ref_legal_entity_id: '1' ref_terms_and_conditions_locale_id: 11l100 terms_and_conditions: You must accept these terms and conditions to join tnc_type: entity schema: properties: terms: items: $ref: '#/components/schemas/Term_Wrapper' type: array type: object description: OK tags: - Network Terms and Conditions description: '' operationId: List-network-terms-and-conditions summary: List all terms and conditions for a network /campaign: get: parameters: - description: ID of the network example: 11l100 in: query name: network_id required: false schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaigns: - campaign: advertiser_id: 10l110 allow_deep_linking: y allow_third_party_pixel: y append_url_parameters: '' associated_campaigns: '' automated_invoicing_date: 4 automated_invoicing_po_number: null auto_approve_publisher: y auto_rejected_ips: null basket_value_cap: null budget_summary_interval: null budget_summary_start_time: null campaign_currency_conversions: [] campaign_id: 10l176 campaign_languages: null campaign_logo: http://partnerize.com/logo.png campaign_notes: '' campaign_overloads: [] commission_by_meta_label: '[ "label 1","label 2" ]' commission_by_meta: '[ "field_1","field_2" ]' commissions: [] conversion_hiatus_period: 7 conversion_type: sale cookie_period: 0 cookie_status: null default_commission_rate: '5' default_currency: GBP default_override: 10 deferred_lead_submission: null description: en:

Awesome new campaign

destination_url: http://www.performancehorizon.com dont_consolidate: y dont_invoice: y extra_restricted_deep_linking: '' force_approve_period: 0 hidden_campaign: y invoice_address_1: null invoice_address_2: null invoice_address_3: null invoice_address_4: null invoice_address_country: null invoice_address_postcode: null invoice_company: null invoice_contact: null invoice_only: null ip_tracking_time: 0 is_cpc: y lead_confirmation_url_fail: '' lead_confirmation_url_success: '' multiple_conversions_per_click: n network_fee: null pay_publisher_directly: y payment_date: null prepend_url_string: http://google.com recurring_payment_setup: y report_meta_purge_period: null reporting_timezone: Australia/Sydney restricted_deep_linking: y secure_tracking: y status: a terms: en: terms: Important campaign terms and conditions test_mode: y title: PHG Aff Demo tq_auto_approve: 60 tq_enabled: y tq_enabled_publishers: '' tracking_method: s2s tracking_subdomain: null unique_conversion_refs: y vertical_id: 10 vertical_name: Other week_start: Monday advertiser_name: Advertiser Name schema: properties: campaigns: items: $ref: '#/components/schemas/Campaign_Wrapper' type: array description: OK tags: - Campaigns description: 'Return the details of all Campaigns attached to the Network account and visible to the authenticated User. The output is contextual based on the permissions of the User making the request to the endpoint. A limited Campaign schema will be utilised for any Campaign that the User does not have appropriate permissions to view.' operationId: listAllCampaigns summary: List all Campaigns post: responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign: advertiser_id: 10l110 allow_deep_linking: y allow_third_party_pixel: y append_url_parameters: '' associated_campaigns: '' automated_invoicing_date: 4 automated_invoicing_po_number: null auto_approve_publisher: y auto_rejected_ips: null budget_summary_interval: null budget_summary_start_time: null campaign_currency_conversions: [] campaign_id: 10l176 campaign_languages: null campaign_logo: http://performancehorizon.com/logo.png campaign_notes: '' campaign_overloads: [] commission_by_meta_label: '[ "label 1","label 2" ]' commission_by_meta: '[ "field_1","field_2" ]' commissions: [] conversion_hiatus_period: 7 conversion_type: sale cookie_period: 0 cookie_status: null default_commission_rate: '5' default_currency: GBP default_override: 10 deferred_lead_submission: null description: en:

Awesome new campaign

destination_url: http://www.performancehorizon.com dont_consolidate: y dont_invoice: y extra_restricted_deep_linking: '' force_approve_period: 0 hidden_campaign: y invoice_address_1: null invoice_address_2: null invoice_address_3: null invoice_address_4: null invoice_address_country: null invoice_address_postcode: null invoice_company: null invoice_contact: null invoice_only: null ip_tracking_time: 0 is_cpc: y lead_confirmation_url_fail: '' lead_confirmation_url_success: '' multiple_conversions_per_click: n network_fee: null pay_publisher_directly: y payment_date: null prepend_url_string: http://google.com promotional_countries: - iso: US name: United States - iso: GB name: United Kingdom recurring_payment_setup: y report_meta_purge_period: null reporting_timezone: Australia/Sydney restricted_deep_linking: y secure_tracking: y status: a terms: en: terms: Important campaign terms and conditions test_mode: y title: PHG Aff Demo tq_auto_approve: 60 tq_enabled: y tq_enabled_publishers: '' tracking_method: s2s tracking_subdomain: null unique_conversion_refs: y vertical_id: 10 vertical_name: Other week_start: Monday advertiser_name: Advertiser Name schema: properties: $ref: '#/components/schemas/Campaign_Wrapper' description: OK tags: - Campaigns description: To create a new Campaign, the Brand must pass their associated `advertiser_id`. operationId: createACampaign requestBody: content: application/json: schema: example: advertiser_id: 10l110 allow_deep_linking: y allow_third_party_pixel: y append_url_parameters: '' associated_campaigns: '' auto_rejected_ips: null campaign_overloads: - publisher_id: 11111l1 append_url_parameters: ?a=b&c=d basket_value_cap: 10.01 default_destination: http://example.com description: Example hide_hybrid_from_publisher: y is_cpc: n prepend_url_string: http://example.com test_mode: y campaign_icon: http://example.com/path/to/image.png campaign_logo: http://performancehorizon.com/logo.png campaign_notes: '' cookie_period: 0 default_commission_rate: '5' default_currency: GBP description: en:

Awesome new campaign

destination_url: http://www.performancehorizon.com hidden_campaign: y multiple_conversions_per_click: n prepend_url_string: http://google.com secure_tracking: y terms: en: terms: Important campaign terms and conditions test_mode: y title: PHG Aff Demo tq_auto_approve: 60 tracking_method: s2s unique_conversion_refs: y vertical_id: 10 vertical_name: Other oneOf: - properties: default_commission_rate: type: string type: object - properties: default_commission_value: type: string type: object properties: advertiser_id: description: ID of the brand the campaign should belong to type: string allow_deep_linking: $ref: '#/components/schemas/YesOrNo' allow_third_party_pixel: $ref: '#/components/schemas/YesOrNo' append_url_parameters: type: string associated_campaigns: type: string auto_rejected_ips: nullable: true type: string campaign_icon: nullable: true description: Url of image to download. Supports PNG and JPEG only. type: string campaign_icon_upload: description: Base64 encoded data url of image to upload. Supports PNG and JPEG only. type: string nullable: true campaign_logo: nullable: true type: string campaign_overloads: nullable: true type: array items: type: object properties: publisher_id: type: string append_url_parameters: type: string basket_value_cap: type: string default_destination: type: string description: type: string hide_hybrid_from_publisher: $ref: '#/components/schemas/YesOrNo' is_cpc: $ref: '#/components/schemas/YesOrNo' prepend_url_string: type: url test_mode: $ref: '#/components/schemas/YesOrNo' required: - publisher_id campaign_notes: type: string cookie_period: type: number default_currency: enum: - GBP - USD - EUR - JPY type: string description: nullable: true properties: en: type: string description: 'Supports the following HTML tags with no attributes: p, h1-h6, b, i, u, ol, ul, li' type: object destination_url: type: string hidden_campaign: $ref: '#/components/schemas/YesOrNo' multiple_conversions_per_click: anyOf: - enum: - y - n type: string - enum: - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: number prepend_url_string: description: Prepend all destination URLs nullable: true type: string secure_tracking: $ref: '#/components/schemas/YesOrNo' terms: nullable: true properties: en: properties: terms: type: string type: object type: object test_mode: $ref: '#/components/schemas/YesOrNo' title: type: string tq_auto_approve: type: number tracking_method: enum: - pixel - api - s2s type: string unique_conversion_refs: enum: - y - n - ignore type: string vertical_id: type: number vertical_name: type: string required: - advertiser_id - title - destination_url type: object summary: Create a Campaign /campaign/{campaign_id}: get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign: campaign_icon: https://console.partnerize.com/assets/icons/campaigns/10l176.png advertiser_id: 10l110 allow_deep_linking: y allow_third_party_pixel: y append_url_parameters: '' associated_campaigns: '' automated_invoicing_date: 4 automated_invoicing_po_number: null auto_approve_publisher: y auto_rejected_ips: null budget_summary_interval: null budget_summary_start_time: null campaign_currency_conversions: [] campaign_id: 10l176 campaign_languages: null campaign_logo: http://performancehorizon.com/logo.png campaign_notes: '' campaign_overloads: [] commission_by_meta_label: '[ "label 1","label 2" ]' commission_by_meta: '[ "field_1","field_2" ]' commissions: [] conversion_hiatus_period: 7 conversion_type: sale cookie_period: 0 cookie_status: null default_commission_rate: '5' default_currency: GBP default_override: 10 deferred_lead_submission: null description: en: Awesome new campaign destination_url: http://www.performancehorizon.com dont_consolidate: y dont_invoice: y extra_restricted_deep_linking: '' force_approve_period: 0 hidden_campaign: y invoice_address_1: null invoice_address_2: null invoice_address_3: null invoice_address_4: null invoice_address_country: null invoice_address_postcode: null invoice_company: null invoice_contact: null invoice_only: null ip_tracking_time: 0 is_cpc: y lead_confirmation_url_fail: '' lead_confirmation_url_success: '' multiple_conversions_per_click: n network_fee: null pay_publisher_directly: y payment_date: null prepend_url_string: http://google.com promotional_countries: - iso: US name: United States - iso: GB name: United Kingdom recurring_payment_setup: y report_meta_purge_period: null reporting_timezone: Australia/Sydney restricted_deep_linking: y secure_tracking: y status: a terms: en: terms: Important campaign terms and conditions test_mode: y title: PHG Aff Demo tq_auto_approve: 60 tq_enabled: y tq_enabled_publishers: '' tracking_method: s2s tracking_subdomain: null unique_conversion_refs: y vertical_id: 10 vertical_name: Other week_start: Monday advertiser_name: Advertiser Name schema: $ref: '#/components/schemas/Campaign_Wrapper' description: OK tags: - Campaigns description: Outputs the specified Campaign. operationId: Retrieve a Campaign summary: Retrieve a Campaign post: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign: campaign_icon: http://example.com/path/to/image.png advertiser_id: 10l110 allow_deep_linking: y allow_third_party_pixel: y append_url_parameters: '' associated_campaigns: '' automated_invoicing_date: 4 automated_invoicing_po_number: null auto_approve_publisher: y auto_rejected_ips: null budget_summary_interval: null budget_summary_start_time: null campaign_currency_conversions: [] campaign_id: 10l176 campaign_languages: null campaign_logo: http://performancehorizon.com/logo.png campaign_notes: '' campaign_overloads: [] commission_by_meta_label: '[ "label 1","label 2" ]' commission_by_meta: '[ "field_1","field_2" ]' commissions: [] conversion_hiatus_period: 7 conversion_type: sale cookie_period: 0 cookie_status: null default_commission_rate: '5' default_currency: GBP default_override: 10 deferred_lead_submission: null description: en: Awesome new campaign destination_url: http://www.performancehorizon.com dont_consolidate: y dont_invoice: y extra_restricted_deep_linking: '' force_approve_period: 0 hidden_campaign: y invoice_address_1: null invoice_address_2: null invoice_address_3: null invoice_address_4: null invoice_address_country: null invoice_address_postcode: null invoice_company: null invoice_contact: null invoice_only: null ip_tracking_time: 0 is_cpc: y lead_confirmation_url_fail: '' lead_confirmation_url_success: '' multiple_conversions_per_click: n network_fee: null pay_publisher_directly: y payment_date: null prepend_url_string: http://google.com recurring_payment_setup: y report_meta_purge_period: null reporting_timezone: Australia/Sydney restricted_deep_linking: y secure_tracking: y status: a terms: en: terms: Important campaign terms and conditions test_mode: y title: PHG Aff Demo tq_auto_approve: 60 tq_enabled: y tq_enabled_publishers: '' tracking_method: s2s tracking_subdomain: null unique_conversion_refs: y vertical_id: 10 vertical_name: Other week_start: Monday status: campaign_id: 10l176 message: Campaign successfully deleted retire_reason: No longer needed status: Deleted schema: properties: $ref: '#/components/schemas/Campaign_Wrapper' status: properties: campaign_id: type: string message: type: string retire_reason: type: string status: type: string type: object description: OK headers: {} tags: - Campaigns description: 'To delete a specific campaign, you must pass 3 required parameters: 1. `''action'' => ''delete''` 2. `''campaign_id'' => ''''` 3. `''retire_reason'' => ''some excuse''`.' operationId: Delete a Campaign requestBody: content: application/json: schema: example: action: delete campaign_id: 10l176 retire_reason: No longer needed properties: action: type: string campaign_id: description: ID of the campaign type: string retire_reason: type: string required: - campaign_id - action - retire_reason type: object summary: Delete a Campaign put: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign: campaign_icon: https://console.partnerize.com/assets/icons/campaigns/10l176.png advertiser_id: 10l110 allow_deep_linking: y allow_third_party_pixel: y append_url_parameters: '' associated_campaigns: '' automated_invoicing_date: 4 automated_invoicing_po_number: null auto_approve_publisher: y auto_rejected_ips: null budget_summary_interval: null budget_summary_start_time: null campaign_currency_conversions: [] campaign_id: 10l176 campaign_languages: null campaign_logo: http://performancehorizon.com/logo.png campaign_notes: '' campaign_overloads: [] commission_by_meta_label: '[ "label 1","label 2" ]' commission_by_meta: '[ "field_1","field_2" ]' commissions: [] conversion_hiatus_period: 7 conversion_type: sale cookie_period: 0 cookie_status: null default_commission_rate: '5' default_currency: GBP default_override: 10 deferred_lead_submission: null description: en: Awesome new campaign destination_url: http://www.performancehorizon.com dont_consolidate: y dont_invoice: y extra_restricted_deep_linking: '' force_approve_period: 0 hidden_campaign: y invoice_address_1: null invoice_address_2: null invoice_address_3: null invoice_address_4: null invoice_address_country: null invoice_address_postcode: null invoice_company: null invoice_contact: null invoice_only: null ip_tracking_time: 0 is_cpc: y lead_confirmation_url_fail: '' lead_confirmation_url_success: '' multiple_conversions_per_click: n network_fee: null pay_publisher_directly: y payment_date: null prepend_url_string: http://google.com recurring_payment_setup: y report_meta_purge_period: null reporting_timezone: Australia/Sydney restricted_deep_linking: y secure_tracking: y status: a terms: en: terms: terms for the locale test_mode: y title: PHG Aff Demo tq_auto_approve: 60 tq_enabled: y tq_enabled_publishers: '' tracking_method: s2s tracking_subdomain: null unique_conversion_refs: y vertical_id: 10 vertical_name: Other week_start: Monday schema: $ref: '#/components/schemas/Campaign_Wrapper' description: OK tags: - Campaigns description: Update the specified Campaign. operationId: Update a Campaign requestBody: content: application/json: schema: properties: campaign_id: description: ID of the campaign type: string example: 10l176 destination_url: type: string format: uri example: http://www.partnerize.com minLength: 1 title: type: string example: PHG Aff Demo minLength: 5 maxLength: 45 terms: properties: en: properties: terms: type: string example: terms for the en locale type: object type: object promotional_countries: type: array items: type: object properties: iso: type: string example: GB associated_campaigns: type: string auto_rejected_ips: type: string description: Comma separated list example: 1.1.1.1,2.2.2.2 campaign_notes: type: string campaign_overloads: nullable: true type: array items: type: object properties: publisher_id: type: string append_url_parameters: type: string example: ?a=b&c=d basket_value_cap: type: float example: 10.01 default_destination: type: string description: type: string hide_hybrid_from_publisher: $ref: '#/components/schemas/YesOrNo' is_cpc: $ref: '#/components/schemas/YesOrNo' prepend_url_string: type: url example: http://example.com test_mode: $ref: '#/components/schemas/YesOrNo' required: - publisher_id week_start: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday vertical_id: type: string default_currency: type: string example: GBP multiple_conversions_per_click: oneOf: - type: string enum: - y - n - suppress - type: integer unique_conversion_refs: type: string enum: - y - n - ignore reporting_timezone: type: string example: Australia/Melbourne tracking_method: type: string enum: - pixel - s2s - api deeplink_method: type: string enum: - standard - direct cookie_period: type: integer minimum: 0 tq_auto_approve: type: integer minimum: 0 campaign_logo: type: string format: uri short_link_subdomain: type: string minLength: 1 app_tracking_provider: type: string enum: - branch - partnerize app_tracking_provider_tracking_link: type: string test_mode: type: string enum: - y - n hidden_campaign: type: string enum: - y - n allow_deep_linking: type: string enum: - y - n allow_third_party_pixel: type: string enum: - y - n secure_tracking: type: string enum: - y - n is_cpc: type: string enum: - y - n append_url_parameters: type: string prepend_url_string: type: string format: uri description: type: object properties: en: type: string description: 'Supports the following HTML tags with no attributes: p, h1-h6, b, i, u, ol, ul, li' campaign_languages: type: object properties: en: type: object properties: destination_url: type: string format: uri oneOf: - type: object properties: campaign_icon: nullable: true description: Url of image to download. Supports PNG and JPEG only. type: string - type: object properties: campaign_icon_upload: description: Base64 encoded data url of image to upload. Supports PNG and JPEG only. type: string nullable: true example: data:image/png;base64,... required: - campaign_id type: object summary: Update a Campaign /campaign/{campaign_id}/publisher: get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: publishers: - publisher: abn: null account_name: partner123 campaign_custom_terms_and_conditions_id: 10l176 campaign_custom_terms_and_conditions_title: Some fancy title campaign_select: null campaign_status: a company_division: null company_name: Demo Partner contact_email: demo@partnerize.com contact_locale: bg contact_name: John Smith databases: - active: y creation_method: Email database_id: 111111l300347 database_name: Partnerize Database female: 50 male: 50 max_age: 77 min_age: 25 publisher_id: 1l1007802 size: 53000 default_currency: GBP description: null foreign_identifier: null gst_registered: null im_provider: Skype im_username: elisangis is_affiliate_user: y is_foreign_network: y is_lead_user: y legal_entity: GB network_id: 1l1000003 network_notes: null network_status: a operating_country: GB phone: 01595725007 phone_area: '+44' promotional_method: 10 promotional_method_name: Portal publisher_id: 1l1007802 reporting_identifier: null reporting_timezone: Australia/Sydney signup_ip: 178.23.129.160 uk_vat_registered: y us_tax_state: null vat_number: 974997534 vertical: 10 vertical_name: Other websites: - active: y primary: n description: Demo Partner website publisher_id: 1l1007802 website_country: GB website_id: 11l18694 website_name: null website_type: 9 website_type_name: PPC website_url: http://www.partnerize.com website_vertical: 10 website_vertical_name: Technical week_start: Monday schema: properties: publishers: items: $ref: '#/components/schemas/Publisher_Wrapper' type: array type: object description: OK tags: - Participating Partners description: View all Partners Participating on the Campaign. operationId: List all Participating Partners summary: List all Participating Partners post: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: publishers: - publisher: abn: null account_name: partner123 campaign_custom_terms_and_conditions_id: 10l176 campaign_custom_terms_and_conditions_title: Some fancy title campaign_select: null campaign_status: a company_division: null company_name: Demo Partner contact_email: demo@partnerize.com contact_locale: bg contact_name: John Smith databases: - active: y creation_method: Email database_id: 111111l300347 database_name: Partnerize Database female: 50 male: 50 max_age: 77 min_age: 25 publisher_id: 1l1007802 size: 53000 default_currency: GBP description: null foreign_identifier: null gst_registered: null im_provider: Skype im_username: elisangis is_affiliate_user: y is_foreign_network: y is_lead_user: y legal_entity: GB network_id: 1l1000003 network_notes: null network_status: a operating_country: GB phone: 01595725007 phone_area: '+44' promotional_method: 10 promotional_method_name: Portal publisher_id: 1l1007802 reporting_identifier: null reporting_timezone: Australia/Sydney signup_ip: 178.23.129.160 uk_vat_registered: y us_tax_state: null vat_number: 974997534 vertical: 10 vertical_name: Other websites: - active: y primary: n description: Demo Partner website publisher_id: 1l1007802 website_country: GB website_id: 11l18694 website_name: null website_type: 9 website_type_name: PPC website_url: http://www.partnerize.com website_vertical: 10 website_vertical_name: Technical week_start: Monday schema: properties: publishers: items: $ref: '#/components/schemas/Publisher_Wrapper' type: array type: object description: OK tags: - Participating Partners description: 'Add new Campaign participations by passing each `publisher_id` along with the relevant `campaign_status` in an object within a `publishers` array.' operationId: update-partner-participation requestBody: content: application/json: schema: example: publishers: - campaign_status: a publisher_id: 1l1007802 properties: publishers: items: properties: campaign_status: $ref: '#/components/schemas/Status' publisher_id: type: string required: - campaign_status - publisher_id type: array summary: Update a Partner Participation on a Campaign /campaign/{campaign_id}/publisher/{publisher_id}: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the Partner example: 1l1007802 in: path name: publisher_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: publishers: - publisher: abn: null account_name: partner123 campaign_custom_terms_and_conditions_id: 10l176 campaign_custom_terms_and_conditions_title: Some fancy title campaign_select: null campaign_status: a company_division: null company_name: Demo Partner contact_email: demo@partnerize.com contact_locale: bg contact_name: John Smith databases: - active: y creation_method: Email database_id: 111111l300347 database_name: Partnerize Database female: 50 male: 50 max_age: 77 min_age: 25 publisher_id: 1l1007802 size: 53000 default_currency: GBP description: null foreign_identifier: null gst_registered: null im_provider: Skype im_username: elisangis is_affiliate_user: y is_foreign_network: y is_lead_user: y legal_entity: GB network_id: 1l1000003 network_notes: null network_status: a operating_country: GB phone: 01595725007 phone_area: '+44' promotional_method: 10 promotional_method_name: Portal publisher_id: 1l1007802 reporting_identifier: null reporting_timezone: Australia/Sydney signup_ip: 178.23.129.160 uk_vat_registered: y us_tax_state: null vat_number: 974997534 vertical: 10 vertical_name: Other websites: - active: y primary: n description: Demo Partner website publisher_id: 1l1007802 website_country: GB website_id: 11l18694 website_name: null website_type: 9 website_type_name: PPC website_url: http://www.partnerize.com website_vertical: 10 website_vertical_name: Technical week_start: Monday schema: properties: publishers: items: $ref: '#/components/schemas/Publisher_Wrapper' type: array type: object description: OK tags: - Participating Partners description: View a specific Participating Partner. operationId: Retrieve a Participating Partner summary: Retrieve a Participating Partner /user/advertiser/{advertiser_id}/campaign: get: parameters: - description: ID of the brand example: 10l110 in: path name: advertiser_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaigns: - campaign: advertiser_id: 10l110 allow_deep_linking: y allow_third_party_pixel: y append_url_parameters: '' associated_campaigns: '' automated_invoicing_date: 4 automated_invoicing_po_number: null auto_approve_publisher: y auto_rejected_ips: null budget_summary_interval: null budget_summary_start_time: null campaign_currency_conversions: [] campaign_id: 10l176 campaign_languages: null campaign_logo: http://partnerize.com/logo.png campaign_notes: '' campaign_overloads: [] commission_by_meta_label: '["label 1","label 2"]' commission_by_meta: '["field_1","field_2"]' commissions: [] conversion_hiatus_period: 7 conversion_type: sale cookie_period: 0 cookie_status: null default_commission_rate: '5' default_currency: GBP default_override: 10 deferred_lead_submission: null description: en: Awesome new campaign destination_url: http://www.partnerize.com dont_consolidate: y dont_invoice: y extra_restricted_deep_linking: '' force_approve_period: 0 hidden_campaign: y invoice_address_1: null invoice_address_2: null invoice_address_3: null invoice_address_4: null invoice_address_country: null invoice_address_postcode: null invoice_company: null invoice_contact: null invoice_only: null ip_tracking_time: 0 is_cpc: y lead_confirmation_url_fail: '' lead_confirmation_url_success: '' multiple_conversions_per_click: n network_fee: null pay_publisher_directly: y payment_date: null prepend_url_string: http://google.com recurring_payment_setup: y report_meta_purge_period: null reporting_timezone: Australia/Sydney restricted_deep_linking: y secure_tracking: y status: a terms: en: terms: Important campaign terms and conditions test_mode: y title: PHG Aff Demo tq_auto_approve: 60 tq_enabled: y tq_enabled_publishers: '' tracking_method: s2s tracking_subdomain: null unique_conversion_refs: y vertical_id: 10 vertical_name: Other week_start: Monday count: 5 execution_time: 0.08001 seconds schema: properties: campaigns: items: $ref: '#/components/schemas/Campaign_Wrapper' type: array count: type: number execution_time: type: string type: object description: OK tags: - Campaigns description: 'This endpoint will output a listing of all Campaigns that reside under the provided Brand on the Network and the output is contextual based on the permissions of the User making the request to the endpoint. A limited Campaign schema will be utilised for any Campaign that the User does not have appropriate permissions to view.' operationId: List all Brand Campaigns summary: List all Brand Campaigns /user/advertiser: get: parameters: - description: '' example: '100' in: query name: limit required: false schema: type: number - description: '' example: '0' in: query name: offset required: false schema: type: number responses: '200': content: application/json; charset=utf-8: examples: response: value: advertisers: - advertiser: account_name: demo_brand address1: Gardegasse 11 address2: Top 7 address3: London address4: null advertiser_id: 10l110 budget_summary_interval: null budget_summary_start_time: null company_name: Partnerize Demo Brand contact_email: someone@partnerize.com country: GB current_balance: null default_currency: GBP display_name: PHG payment_currency: GBP phone: 01595725007 phone_area: '+44' postcode: A-101 pre_payment: null signup_ip: 178.23.129.160 status: a vat_number: GB974997534 count: 86 execution_time: 0.23640 seconds limit: 100 offset: 0 schema: properties: advertisers: items: $ref: '#/components/schemas/Brand_Account_Wrapper' type: array count: type: number execution_time: type: string limit: type: number offset: type: number type: object description: OK tags: - Brands description: 'One or more Brands can reside on a Network. This endpoint will output a listing of all Brands who reside on the Network and the output is contextual based on the permissions of the User making the request to the endpoint. A limited Brand schema will be utilised for any Brand that the User does not have appropriate permissions to view.' operationId: List all Brands summary: List all Brands post: responses: '200': content: application/json; charset=utf-8: examples: response: value: advertiser: account_name: demo_brand address1: Gardegasse 11 address2: Top 7 address3: London address4: null advertiser_id: 10l110 budget_summary_interval: null budget_summary_start_time: null company_name: Partnerize Demo Brand contact_email: someone@partnerize.com country: GB current_balance: null default_currency: GBP display_name: PHG payment_currency: GBP phone: 01595725007 phone_area: '+44' postcode: A-101 pre_payment: null signup_ip: 178.23.129.160 status: a vat_number: GB974997534 schema: $ref: '#/components/schemas/Brand_Account_Wrapper' description: OK tags: - Brands description: Create a new Brand account attached to the authenticated User. operationId: Create Brand Account requestBody: content: application/json: schema: example: account_name: newbrand123 address1: Gardegasse 11 address2: Top 7 address3: London address4: null company_name: PHG Demo Brand country: GB display_name: PHG phone: 01595725007 phone_area: '+44' postcode: A-101 signup_ip: 178.23.129.160 $ref: '#/components/schemas/Brand_Account' summary: Create Brand /user/advertiser/{advertiser_id}: get: parameters: - description: ID of the brand example: 10l110 in: path name: advertiser_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: advertiser: account_name: demo_brand address1: Gardegasse 11 address2: Top 7 address3: London address4: null advertiser_id: 10l110 budget_summary_interval: null budget_summary_start_time: null company_name: Partnerize Demo Brand contact_email: someone@partnerize.com country: GB current_balance: null default_currency: GBP display_name: PHG payment_currency: GBP phone: 01595725007 phone_area: '+44' postcode: A-101 pre_payment: null signup_ip: 178.23.129.160 status: a vat_number: GB974997534 schema: $ref: '#/components/schemas/Brand_Account_Wrapper' description: OK tags: - Brands description: Outputs the specified brand. operationId: Retrieve a Brand summary: Retrieve a Brand post: parameters: - description: ID of the brand example: 10l110 in: path name: advertiser_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: advertiser: account_name: demo_brand address1: Gardegasse 11 address2: Top 7 address3: London address4: null advertiser_id: 10l110 advertiser_icon: https://console.partnerize.com/assets/icons/10l110.png budget_summary_interval: null budget_summary_start_time: null company_name: Partnerize Demo Brand contact_email: someone@partnerize.com country: GB current_balance: null default_currency: GBP display_name: PHG payment_currency: GBP phone: 01595725007 phone_area: '+44' postcode: A-101 pre_payment: null signup_ip: 178.23.129.160 status: a vat_number: GB974997534 schema: $ref: '#/components/schemas/Brand_Account_Wrapper' description: OK tags: - Brands description: Update the specified Brand. operationId: Update a Brand requestBody: content: application/json: schema: example: address1: Gardegasse 11 address2: Top 7 address3: London address4: null advertiser_id: 10l110 advertiser_icon: http://example.com/path/to/image.png company_name: Partnerize Demo Brand country: GB phone: 01595725007 phone_area: '+44' postcode: A-101 signup_ip: 178.23.129.160 properties: address1: description: 1st line of the address type: string address2: description: 2nd line of the address nullable: true type: string address3: description: 3rd line of the address nullable: true type: string address4: description: 4th line of the address nullable: true type: string advertiser_id: description: ID of the brand type: string company_name: type: string country: description: Country of the address $ref: '#/components/schemas/Country' phone: description: Primary contact telephone number type: string phone_area: description: Phone prefix to declare country or region nullable: true type: string postcode: description: Postcode/Zipcode attached to the address type: string signup_ip: type: string oneOf: - properties: advertiser_icon: description: Url of image to download. Supports PNG and JPEG only. type: string nullable: true type: object - properties: advertiser_icon_upload: description: Base64 encoded data url of image to upload. Supports PNG and JPEG only. type: string nullable: true type: object required: - address1 - country - postcode - phone - signup_ip type: object summary: Update a Brand /campaign/{campaign_id}/voucher_code: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: voucher_codes: - voucher_code: active: y campaign_id: 10l176 commission_groups: [] description: '' end_date_time: '2013-09-30 15:00:00' on_expiry: ignore on_invalid_user: ignore start_date_time: '2013-08-31 15:00:00' voucher_code: promocode voucher_code_id: 111111l1000015 schema: properties: voucher_codes: items: $ref: '#/components/schemas/Voucher_Code_Wrapper' type: array type: object description: OK tags: - Voucher Codes description: View all Voucher Codes associated with the Campaign. operationId: List all Voucher Codes summary: List all Campaign Voucher Codes post: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: voucher_code: active: y campaign_id: 10l176 commission_groups: [] description: '' end_date_time: '2013-09-30 15:00:00' on_expiry: ignore on_invalid_user: ignore start_date_time: '2013-08-31 15:00:00' voucher_code: promocode voucher_code_id: 111111l1000015 schema: properties: voucher_codes: items: $ref: '#/components/schemas/Voucher_Code_Wrapper' type: array type: object description: OK tags: - Voucher Codes description: 'Create new Vouchers by passing each Voucher object within a `voucher_codes` array. A `voucher_code` string to define the actual code must be passed with each object, and to allocate the Voucher to specific Groups, pass the Group ids in a `commission_groups` array.' operationId: Create Voucher Codes requestBody: content: application/json: schema: example: voucher_codes: - commission_groups: [] description: '' end_date_time: '2013-09-30 15:00:00' start_date_time: '2013-08-31 15:00:00' voucher_code: specialoffer69 properties: voucher_codes: items: properties: commission_groups: description: IDs of the commission groups to be associated with the voucher items: type: string type: array description: type: string voucher_code: type: string start_date_time: type: string end_date_time: type: string type: object type: array type: object summary: Create Voucher Codes put: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: voucher_code: active: y campaign_id: 10l176 commission_groups: [] description: '' end_date_time: '2013-09-30 15:00:00' on_expiry: ignore on_invalid_user: ignore start_date_time: '2013-08-31 15:00:00' voucher_code: promocode voucher_code_id: 111111l1000015 schema: properties: voucher_codes: items: $ref: '#/components/schemas/Voucher_Code_Wrapper' type: array type: object description: OK tags: - Voucher Codes description: Update Vouchers by referencing the `voucher_code_id` in each Group object within the `voucher_codes` array. operationId: Update Voucher Codes requestBody: content: application/json: schema: example: voucher_codes: - commission_groups: [] description: '' end_date_time: '2013-09-30 15:00:00' start_date_time: '2013-08-31 15:00:00' voucher_code: promocode voucher_code_id: 111111l1000015 properties: voucher_codes: items: properties: voucher_code_id: type: string commission_groups: description: IDs of the commission groups to be associated with the voucher items: type: string type: array description: type: string voucher_code: type: string start_date_time: type: string end_date_time: type: string type: object type: array type: object summary: Update Voucher Codes /campaign/{campaign_id}/voucher_code/{voucher_code_id}: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the voucher code example: 111111l1000015 in: path name: voucher_code_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: voucher_code: active: y campaign_id: 10l176 commission_groups: [] description: '' end_date_time: '2013-09-30 15:00:00' on_expiry: ignore on_invalid_user: ignore start_date_time: '2013-08-31 15:00:00' voucher_code: promocode voucher_code_id: 111111l1000015 schema: $ref: '#/components/schemas/Voucher_Code_Wrapper' description: OK tags: - Voucher Codes description: Outputs the specified Voucher Code. operationId: Retrieve a Voucher Code summary: Retrieve a Voucher Code /campaign/{campaign_id}/creative: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: creatives: - creative: tags: '' active: y advertiser_reference: Promotion July 2020 campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_id: '300441' creative_items: - tags: '' active: y campaign_id: 10l176 content_type: image/jpeg created_at: '2016-04-07 04:21:51' created_by: '300621' creative_item_id: '300396' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' description: '' filename: 4fdf4b3879da1funny-animals-page.jpg img_url: https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg preview: https://demo.prf.hn/preview/screativeref:300396 specific_destination: '' creative_tracking_link: '' creative_tracking_link_rotate: '' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' default_specific_creative_id: '300396' description: Demo Text destination: http://www.partnerize.com dynamic_tracking_link: '' end_date_time: '2013-09-30 15:00:00' height: 360 html_tracking_link: '' limits: '' preview: https://demo.prf.hn/preview/creativeref:300442 start_date_time: '2013-08-31 15:00:00' width: 400 schema: properties: creatives: items: $ref: '#/components/schemas/Creative_Wrapper' type: array type: object description: OK tags: - Creatives description: List and view all Creatives for the specified Campaign. operationId: List all Creatives for a Campaign summary: List all Creatives for a Campaign post: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: creatives: - creative: tags: '' active: y advertiser_reference: Promotion July 2016 campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_id: '300441' creative_items: - tags: '' active: y campaign_id: 10l176 content_type: image/jpeg created_at: '2016-04-07 04:21:51' created_by: '300621' creative_item_id: '300396' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' description: '' filename: 4fdf4b3879da1funny-animals-page.jpg img_url: https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg preview: https://demo.prf.hn/preview/screativeref:300396 specific_destination: '' creative_tracking_link: '' creative_tracking_link_rotate: '' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' default_specific_creative_id: '300396' description: Demo Text destination: http://www.partnerize.com dynamic_tracking_link: '' end_date_time: '2013-09-30 15:00:00' height: 360 html_tracking_link: '' limits: '' preview: https://demo.prf.hn/preview/creativeref:300442 start_date_time: '2013-08-31 15:00:00' width: 400 schema: properties: creatives: items: $ref: '#/components/schemas/Creative_Wrapper' type: array type: object description: OK tags: - Creatives description: Create one or more Creatives against the Campaign entity. Each Creative is sent as an array within a top level `creatives` array. operationId: Create Campaign Creatives requestBody: content: application/json: schema: example: creatives: - tags: '' active: y advertiser_reference: Promotion July 2016 campaign_id: 10l176 creative_items: - tags: '' active: y campaign_id: 10l176 content_type: image/jpeg created_at: '2016-04-07 04:21:51' created_by: '300621' creative_item_id: '300396' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' description: '' filename: 4fdf4b3879da1funny-animals-page.jpg img_url: https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg preview: https://demo.prf.hn/preview/screativeref:300396 specific_destination: '' creative_tracking_link: '' creative_tracking_link_rotate: '' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' default_specific_creative_id: '300396' description: Demo Text destination: http://www.partnerize.com dynamic_tracking_link: '' end_date_time: '2013-09-30 15:00:00' height: 360 html_tracking_link: '' limits: '' preview: https://demo.prf.hn/preview/creativeref:300442 start_date_time: '2013-08-31 15:00:00' width: 400 properties: creatives: items: $ref: '#/components/schemas/Creative_Wrapper' type: array type: object summary: Create Campaign Creatives put: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: creatives: - creative: tags: '' active: y advertiser_reference: Promotion July 2016 campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_id: '300441' creative_items: - tags: '' active: y campaign_id: 10l176 content_type: image/jpeg created_at: '2016-04-07 04:21:51' created_by: '300621' creative_item_id: '300396' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' description: '' filename: 4fdf4b3879da1funny-animals-page.jpg img_url: https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg preview: https://demo.prf.hn/preview/screativeref:300396 specific_destination: '' creative_tracking_link: '' creative_tracking_link_rotate: '' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' default_specific_creative_id: '300396' description: Demo Text destination: http://www.partnerize.com dynamic_tracking_link: '' end_date_time: '2013-09-30 15:00:00' height: 360 html_tracking_link: '' limits: '' preview: https://demo.prf.hn/preview/creativeref:300442 start_date_time: '2013-08-31 15:00:00' width: 400 schema: properties: creatives: items: $ref: '#/components/schemas/Creative_Wrapper' type: array type: object description: OK tags: - Creatives description: Update one or more Creatives against the Campaign entity. Each Creative is sent as an array within a top level `creatives` array and must contain its associated `creative_id`. operationId: Update Campaign Creatives requestBody: content: application/json: schema: example: creatives: - tags: '' active: y advertiser_reference: Promotion July 2016 campaign_id: 10l176 creative_id: '300441' creative_items: - tags: '' active: y campaign_id: 10l176 content_type: image/jpeg created_at: '2016-04-07 04:21:51' created_by: '300621' creative_item_id: '300396' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' description: '' filename: 4fdf4b3879da1funny-animals-page.jpg img_url: https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg preview: https://demo.prf.hn/preview/screativeref:300396 specific_destination: '' creative_tracking_link: '' creative_tracking_link_rotate: '' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' default_specific_creative_id: '300396' description: Demo Text destination: http://www.partnerize.com dynamic_tracking_link: '' end_date_time: '2013-09-30 15:00:00' height: 360 html_tracking_link: '' limits: '' preview: https://demo.prf.hn/preview/creativeref:300442 start_date_time: '2013-08-31 15:00:00' width: 400 properties: creatives: items: $ref: '#/components/schemas/Creative_Wrapper' type: array type: object summary: Update Campaign Creatives /campaign/{campaign_id}/creative/tags: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: creative_tags: - creative_tag: campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_tag_id: 111111l2 creatives: - creative_id: '300441' creative_item_id: '300396' name: logo schema: properties: creative_tags: items: $ref: '#/components/schemas/Creative_Tag_Wrapper' type: array type: object description: OK tags: - Creatives description: View all Creative Tags for the specified Campaign. operationId: List all Creative Tags for Campaign summary: List all Creative Tags for Campaign post: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: creative_tags: - creative_tag: campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_tag_id: 111111l2 creatives: - creative_id: '300441' creative_item_id: '300396' name: logo schema: properties: creative_tags: items: $ref: '#/components/schemas/Creative_Tag_Wrapper' type: array type: object description: OK tags: - Creatives description: Create one or more Creative Tags against the Campaign entity. Each Tag is sent as an array within a top level `tags` array. operationId: Create Campaign Creative Tags requestBody: content: application/json: schema: example: tags: - name: promo properties: tags: items: $ref: '#/components/schemas/Creative_Tag_Wrapper' type: array type: object summary: Create Campaign Creative Tags put: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: creative_tags: - creative_tag: campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_tag_id: 111111l2 creatives: - creative_id: '300441' creative_item_id: '300396' name: logo schema: properties: creative_tags: items: $ref: '#/components/schemas/Creative_Tag_Wrapper' type: array type: object description: OK tags: - Creatives description: Update one or more Creative Tags against the Campaign entity. Each Tag is sent as an array within a top level `tags` array and must contain its associated `creative_tag_id`. operationId: Update Campaign Creative Tags requestBody: content: application/json: schema: example: tags: - creative_tag_id: 111111l2 name: promotion properties: tags: items: $ref: '#/components/schemas/Creative_Tag_Wrapper' type: array type: object summary: Update Campaign Creative Tags delete: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: creative_tags: - creative_tag: campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_tag_id: 111111l2 creatives: - creative_id: '300441' creative_item_id: '300396' name: logo schema: properties: creative_tags: items: $ref: '#/components/schemas/Creative_Tag_Wrapper' type: array type: object description: OK tags: - Creatives description: Delete one or more Creative Tags against the Campaign entity. Each Tag is sent as an array within a top level `tags` array and must contain its associated `creative_tag_id`. operationId: Delete Campaign Creative Tags requestBody: content: application/json: schema: example: tags: - creative_tag_id: 111111l2 properties: tags: items: $ref: '#/components/schemas/Creative_Tag_Wrapper' type: array type: object summary: Delete Campaign Creative Tags /campaign/{campaign_id}/creative_tags/creative: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: An array of tags IDs to filter the creatives by example: 1011l56,1011l57 in: query name: tags[] required: false schema: type: string allowReserved: true responses: '200': content: application/json; charset=utf-8: examples: response: value: creatives: - creative: tags: '' active: y advertiser_reference: Promotion July 2020 campaign_id: 10l176 created_at: '2016-04-07 04:21:51' created_by: '300621' creative_id: '300441' creative_items: - tags: - creative_tag_id: 1011l56 campaign_id: 10l176 name: My tag created_at: '2016-04-03 16:16:02' active: y campaign_id: 10l176 content_type: image/jpeg created_at: '2016-04-07 04:21:51' created_by: '300621' creative_item_id: '300396' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' description: '' filename: 4fdf4b3879da1funny-animals-page.jpg img_url: https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg preview: https://demo.prf.hn/preview/screativeref:300396 specific_destination: '' creative_tracking_link: '' creative_tracking_link_rotate: '' creative_type_id: 1 custom_append_url_parameters: '' custom_prepend_url_parameters: '' default_specific_creative_id: '300396' description: Demo Text destination: http://www.partnerize.com dynamic_tracking_link: '' end_date_time: '2013-09-30 15:00:00' height: 360 html_tracking_link: '' limits: '' preview: https://demo.prf.hn/preview/creativeref:300442 start_date_time: '2013-08-31 15:00:00' width: 400 schema: properties: creatives: items: $ref: '#/components/schemas/Creative_Wrapper' type: array type: object description: OK tags: - Creatives description: List and view all Creatives for the specified Campaign and filter by tags. operationId: List all Creatives for a Campaign by Tags summary: List all Creatives for a Campaign by Tags /campaign/{campaign_id}/feed: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: feeds: - feed: active: y dynamic: 0 feed_id: 1111l13 fetch_frequency: 3600 filesize: 0 last_processed: 1378980455 location: http://example.com/feed.xml name: Sample Product Feed updated: 1378980455 schema: properties: feeds: items: $ref: '#/components/schemas/Feed_Wrapper' type: array type: object description: OK tags: - Product Feeds description: Return the details of all Product Feeds associated with a Campaign. operationId: List all Product Feeds summary: List all Product Feeds for a Campaign post: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '201': content: application/json; charset=utf-8: examples: response: value: feeds: - feed: active: y dynamic: 0 feed_id: 1111l13 fetch_frequency: 3600 filesize: 0 last_processed: 1378980455 location: http://example.com/feed.xml name: Sample Feed updated: 1378980455 schema: properties: feeds: items: $ref: '#/components/schemas/Feed_Wrapper' type: array type: object description: Created tags: - Product Feeds description: Create one or more Product Feeds against the Campaign entity. Each Product Feed is sent as an array within a top level `feeds` array. operationId: Create a Product Feed for a Campaign requestBody: content: application/json: schema: example: feeds: - active: y dynamic: 0 fetch_frequency: 3600 location: http://example.com/feed.xml name: Sample Feed properties: feeds: items: $ref: '#/components/schemas/Feed' type: array required: - feeds type: object summary: Create a Product Feed put: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: feeds: - feed: action: update active: y dynamic: 0 feed_id: 1111l13 fetch_frequency: 3600 filesize: 0 last_processed: 1378980455 location: http://example.com/feed.xml name: Sample Feed updated: 1378980455 schema: properties: feeds: items: $ref: '#/components/schemas/Feed_Wrapper' type: array type: object description: OK tags: - Product Feeds description: 'Update one or more `feeds` against the Campaign entity. Each Product Feed is sent as an array within a top level `feeds` array and must contain its associated `feed_id` or `location`. As `location` is a unique identifier, it''s not possible to change the location of a feed once created. To update the location, first update the feed and set `active: n`, then create a new feed with the new location.' operationId: Update a Campaign Feed requestBody: content: application/json: schema: example: feeds: - active: y feed_id: 1111l13 fetch_frequency: 3600 name: Sample Feed properties: feeds: items: oneOf: - properties: feed_id: description: ID of the Product Feed type: string type: object - properties: location: description: URL of the feed type: string type: object properties: active: $ref: '#/components/schemas/YesOrNo' fetch_frequency: type: number name: type: string type: object type: array required: - feeds type: object summary: Update a Product Feed for a Campaign /campaign/{campaign_id}/deal: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign_deals: - campaign_deal: active: y advertiser_reference: Promo012 category: Clothing country_iso: GB coupon_code: DEAL45 description: There are a lot of awesome deals destination: https://dealz.bargain/promo end_date_time: '2017-09-01T00:00:00+01:00' offer_type: coupon offer_value: 40% off start_date_time: '2017-08-01T00:00:00+01:00' terms: No terms for this deal title: 40% off everything schema: properties: campaign_deals: items: $ref: '#/components/schemas/Deal_Wrapper' type: array type: object description: OK tags: - Deals description: Return the details of all Deals associated to the Campaign. operationId: List all Campaign Deals summary: List all Campaign Deals post: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '201': content: application/json; charset=utf-8: examples: response: value: campaign_deal: active: y advertiser_reference: Promo012 campaign_deal_id: 111111l2 category: Clothing country_iso: GB coupon_code: DEAL45 created_at: '2017-07-01T00:00:00+01:00' description: There are a lot of awesome deals destination: https://dealz.bargain/promo end_date_time: '2017-09-01T00:00:00+01:00' offer_type: coupon offer_value: 40% off start_date_time: '2017-08-01T00:00:00+01:00' terms: No terms for this deal title: 40% off everything updated_at: null schema: $ref: '#/components/schemas/Deal_Wrapper' description: Created tags: - Deals description: Create a new Deal against the Campaign entity. operationId: Create a Campaign Deal requestBody: content: application/json: schema: $ref: '#/components/schemas/Deal' summary: Create a Campaign Deal /campaign/{campaign_id}/deal/{deal_id}: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the Deal example: 111111l2 in: path name: deal_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign_deal: active: y advertiser_reference: Promo012 campaign_deal_id: 111111l2 category: Clothing country_iso: GB coupon_code: DEAL45 created_at: '2017-07-01T00:00:00+01:00' description: There are a lot of awesome deals destination: https://dealz.bargain/promo end_date_time: '2017-09-01T00:00:00+01:00' offer_type: coupon offer_value: 40% off start_date_time: '2017-08-01T00:00:00+01:00' terms: No terms for this deal title: 40% off everything updated_at: null schema: $ref: '#/components/schemas/Deal_Wrapper' description: OK tags: - Deals description: Review the specified Deal. operationId: Retrieve a Campaign Deal summary: Retrieve a Campaign Deal patch: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the Deal example: 111111l2 in: path name: deal_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign_deal: active: y advertiser_reference: Promo012 campaign_deal_id: 111111l2 category: Clothing country_iso: GB coupon_code: DEAL45 created_at: '2017-07-01T00:00:00+01:00' description: There are a lot of awesome deals destination: https://dealz.bargain/promo end_date_time: '2017-09-01T00:00:00+01:00' offer_type: coupon offer_value: 40% off start_date_time: '2017-08-01T00:00:00+01:00' terms: No terms for this deal title: 40% off everything updated_at: null schema: $ref: '#/components/schemas/Deal_Wrapper' description: OK tags: - Deals description: Update properties of the specified Deal. operationId: Update a Campaign Deal requestBody: content: application/json: schema: example: active: y advertiser_reference: Promo012 category: Clothing country_iso: GB coupon_code: DEAL45 description: There are a lot of awesome deals destination: https://dealz.bargain/promo end_date_time: '2017-09-01T00:00:00+01:00' offer_type: coupon offer_value: 40% off start_date_time: '2017-08-01T00:00:00+01:00' terms: No terms for this deal title: 40% off everything $ref: '#/components/schemas/Deal' summary: Update a Campaign Deal delete: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the deal example: 111111l2 in: path name: deal_id required: true schema: type: string responses: '204': description: No Content tags: - Deals description: Delete a Deal, which is the same as updating the Deal by setting `active` to `n`. operationId: Delete a Campaign summary: Delete a Campaign /campaign/{campaign_id}/meta: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign: campaign_id: 10l176 meta: currencies: - GBP meta_conversion: [] meta_item: [] schema: properties: campaign: properties: campaign_id: description: ID of the campaign type: string meta: properties: currencies: items: $ref: '#/components/schemas/Currency' type: array meta_conversion: items: {} type: array meta_item: items: {} type: array type: object type: object type: object description: OK tags: - Meta Attributes description: View all unique Meta attributes for the Campaign. operationId: List all Meta attributes for Campaign summary: List all Meta attributes for Campaign /campaign/{campaign_id}/tq: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: Filter by the ID of a transaction query example: 1l1000532 in: query name: transaction_query_id required: false schema: type: string - description: Filter by the type example: untracked in: query name: transaction_query_type required: false schema: type: string - description: Filter by a partner reference example: A200FG1 in: query name: publisher_reference required: false schema: type: string - description: Filter by a conversion reference example: AF222PO in: query name: conversion_reference required: false schema: type: string - description: Filter by a conversion date example: '2017-01-01 00:00:00' in: query name: conversion_date_time required: false schema: type: string - description: Filter by the ID of a campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: Filter by the current state example: pending in: query name: current_state required: false schema: type: string - description: Field to filter the date range on example: created_at in: query name: date_range_column required: false schema: type: string - description: Start of a date range example: '2017-01-01 00:00:00' in: query name: date_range_start required: false schema: type: string - description: End of a date range example: '2017-12-30 00:00:00' in: query name: date_range_end required: false schema: type: string - description: Natural language representation of a date range example: last 10 days in: query name: text_date required: false schema: type: string - description: Field to sort the results by example: created_at in: query name: sort_column required: false schema: type: string - description: Direction to sort the results by example: ASC in: query name: order_by required: false schema: type: string - description: Download the results as a CSV file example: 'true' in: query name: tq_export required: false schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: count: 5 execution_time: 0.08001 seconds filters: {} sort: column: created_at direction: ASC transaction_queries: - transaction_query: actions_available: - approve - reject campaign: advertiser_id: 10l110 campaign_id: 10l176 created: '2017-01-01 00:00:00' created_by: 11l16829 default_override: '1' hidden_campaign: y last_modified: '2017-01-01 00:00:00' network_fee: null payment_date: null reporting_timezone: Australia/Sydney status: a title: Example Campaign type: sale vertical_id: 10 week_start: monday campaign_id: 10l176 camref: hrDu67 conversion_currency: GBP conversion_date_time: '2017-01-01 00:00:00' conversion_id: 111111l304972 conversion_reference: AUTO-5953bd8c5fe7b conversion_value: 9729 created_at: '2017-01-01 00:00:00' current_state: pending expected_commission: 907.43 notes: Quam ex rerum nulla enim. publisher: agreed_to_latest_network_terms: y created: '2017-01-01 00:00:00' created_by: 11l16829 name: Example Partner network_id: 1l1000003 network_status: a publisher_id: 1l1007802 ref_terms_and_conditions_locale_id: 1l100284 reporting_timezone: Australia/Sydney signup_ip: 127.0.0.1 week_start: saturday publisher_id: 1l1007802 publisher_reference: rerum state_history: conversion_expected_commission: 837.49 conversion_item_id: 111111l1107235 created_at: '2017-01-01 00:00:00' notes: Quidem facilis iste sapiente reiciendis. state: pending transaction_query_id: 111111l10 transaction_query_state_id: 111111l9 user_id: 11l16829 transaction_query_id: 111111l10 transaction_query_type: untracked updated_at: '2017-02-01 00:00:00' schema: properties: count: type: number execution_time: type: string filters: description: The filters applied to the results properties: {} type: object sort: properties: column: description: The column the results are sorted by type: string direction: description: The direction the results are sorted in enum: - ASC - DESC type: string type: object transaction_queries: items: $ref: '#/components/schemas/Transaction_Query_Wrapper' type: array type: object description: OK tags: - Campaign Transaction Queries description: Return the details of all Transaction Queries created on a campaign. operationId: List all Transaction Queries requestBody: content: application/json: schema: type: string description: Generate a CSV file in a job and send the result to this email address, helpful when processing takes too long for a normal download summary: List all Transaction Queries for a Campaign /campaign/{campaign_id}/tq/{transaction_query_id}/approve: post: parameters: - description: ID of a Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the Transaction Query example: 1l1000532 in: path name: transaction_query_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.08001 seconds transaction_query: actions_available: [] campaign: advertiser_id: 10l110 campaign_id: 10l176 created: '2017-01-01 00:00:00' created_by: 11l16829 default_override: '1' hidden_campaign: y last_modified: '2017-01-01 00:00:00' network_fee: null payment_date: null reporting_timezone: Australia/Sydney status: a title: Example Campaign type: sale vertical_id: 10 week_start: monday campaign_id: 10l176 camref: hrDu67 conversion_currency: GBP conversion_date_time: '2017-01-01 00:00:00' conversion_id: 111111l304972 conversion_reference: AUTO-5953bd8c5fe7b conversion_value: 9729 created_at: '2017-01-01 00:00:00' current_state: pending expected_commission: 907.43 notes: Quam ex rerum nulla enim. publisher: agreed_to_latest_network_terms: y created: '2017-01-01 00:00:00' created_by: 11l16829 name: Example Partner network_id: 1l1000003 network_status: a publisher_id: 1l1007802 ref_terms_and_conditions_locale_id: 1l100284 reporting_timezone: Australia/Sydney signup_ip: 127.0.0.1 week_start: saturday publisher_id: 1l1007802 publisher_reference: rerum state_history: conversion_expected_commission: 837.49 conversion_item_id: 111111l1107235 created_at: '2017-01-01 00:00:00' notes: Quidem facilis iste sapiente reiciendis. state: pending transaction_query_id: 111111l10 transaction_query_state_id: 111111l9 user_id: 11l16829 transaction_query_id: 111111l10 transaction_query_type: untracked updated_at: '2017-02-01 00:00:00' schema: $ref: '#/components/schemas/Transaction_Query_Wrapper' description: OK '400': content: application/json; charset=utf-8: examples: response: value: error: message: Requested action around TQs that does not exists type: '400' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Bad Request '404': content: application/json; charset=utf-8: examples: response: value: error: message: The TQ ID supplied for this action does not match an existing TQ. type: '404' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Not Found tags: - Campaign Transaction Queries description: Approve a single Transaction Query. Only Transaction Queries with a status of pending can be approved. operationId: Approve a Transaction Query requestBody: content: application/json: schema: example: expected_commission: 907.43 properties: expected_commission: description: The commission that the conversion should have after being approved type: number type: object summary: Approve a Transaction Query /campaign/{campaign_id}/tq/{transaction_query_id}/pend: post: parameters: - description: ID of a Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the Transaction Query example: 1l1000532 in: path name: transaction_query_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.08001 seconds transaction_query: actions_available: - approve - reject campaign: advertiser_id: 10l110 campaign_id: 10l176 created: '2017-01-01 00:00:00' created_by: 11l16829 default_override: '1' hidden_campaign: y last_modified: '2017-01-01 00:00:00' network_fee: null payment_date: null reporting_timezone: Australia/Sydney status: a title: Example Campaign type: sale vertical_id: 10 week_start: monday campaign_id: 10l176 camref: hrDu67 conversion_currency: GBP conversion_date_time: '2017-01-01 00:00:00' conversion_id: 111111l304972 conversion_reference: AUTO-5953bd8c5fe7b conversion_value: 9729 created_at: '2017-01-01 00:00:00' current_state: pending expected_commission: 907.43 notes: Quam ex rerum nulla enim. publisher: agreed_to_latest_network_terms: y created: '2017-01-01 00:00:00' created_by: 11l16829 name: Example Partner network_id: 1l1000003 network_status: a publisher_id: 1l1007802 ref_terms_and_conditions_locale_id: 1l100284 reporting_timezone: Australia/Sydney signup_ip: 127.0.0.1 week_start: saturday publisher_id: 1l1007802 publisher_reference: rerum state_history: conversion_expected_commission: 837.49 conversion_item_id: 111111l1107235 created_at: '2017-01-01 00:00:00' notes: Quidem facilis iste sapiente reiciendis. state: pending transaction_query_id: 111111l10 transaction_query_state_id: 111111l9 user_id: 11l16829 transaction_query_id: 111111l10 transaction_query_type: untracked updated_at: '2017-02-01 00:00:00' schema: $ref: '#/components/schemas/Transaction_Query_Wrapper' description: OK '400': content: application/json; charset=utf-8: examples: response: value: error: message: Requested action around TQs that does not exists type: '400' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Bad Request '404': content: application/json; charset=utf-8: examples: response: value: error: message: The TQ ID supplied for this action does not match an existing TQ. type: '404' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Not Found tags: - Campaign Transaction Queries description: Pend a single Transaction Query. Only Transaction Queries with a status of rejected can be pended. operationId: Pend a Transaction Query summary: Pend a Transaction Query /campaign/{campaign_id}/tq/{transaction_query_id}/reject: post: parameters: - description: ID of a campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the transaction query example: 1l1000532 in: path name: transaction_query_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.08001 seconds transaction_query: actions_available: - pend campaign: advertiser_id: 10l110 campaign_id: 10l176 created: '2017-01-01 00:00:00' created_by: 11l16829 default_override: '1' hidden_campaign: y last_modified: '2017-01-01 00:00:00' network_fee: null payment_date: null reporting_timezone: Australia/Sydney status: a title: Example Campaign type: sale vertical_id: 10 week_start: monday campaign_id: 10l176 camref: hrDu67 conversion_currency: GBP conversion_date_time: '2017-01-01 00:00:00' conversion_id: 111111l304972 conversion_reference: AUTO-5953bd8c5fe7b conversion_value: 9729 created_at: '2017-01-01 00:00:00' current_state: pending expected_commission: 907.43 notes: Quam ex rerum nulla enim. publisher: agreed_to_latest_network_terms: y created: '2017-01-01 00:00:00' created_by: 11l16829 name: Example Partner network_id: 1l1000003 network_status: a publisher_id: 1l1007802 ref_terms_and_conditions_locale_id: 1l100284 reporting_timezone: Australia/Sydney signup_ip: 127.0.0.1 week_start: saturday publisher_id: 1l1007802 publisher_reference: rerum state_history: conversion_expected_commission: 837.49 conversion_item_id: 111111l1107235 created_at: '2017-01-01 00:00:00' notes: Quidem facilis iste sapiente reiciendis. state: pending transaction_query_id: 111111l10 transaction_query_state_id: 111111l9 user_id: 11l16829 transaction_query_id: 111111l10 transaction_query_type: untracked updated_at: '2017-02-01 00:00:00' schema: $ref: '#/components/schemas/Transaction_Query_Wrapper' description: OK '400': content: application/json; charset=utf-8: examples: response: value: error: message: Requested action around TQs that does not exists type: '400' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Bad Request '404': content: application/json; charset=utf-8: examples: response: value: error: message: The TQ ID supplied for this action does not match an existing TQ. type: '404' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Not Found tags: - Campaign Transaction Queries description: Reject a single Transaction Query. Only Transaction Queries with a status of pending can be rejected. operationId: Reject a Transaction Query requestBody: content: application/json: schema: example: reason: Example reason properties: reason: description: The reason for rejecting the Transaction Query type: string type: object summary: Reject a Transaction Query /campaign/{campaign_id}/tq/process: post: parameters: - description: ID of a Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.08001 seconds job: completed_at: '2016-04-07 04:21:52' created_at: '2016-04-07 04:21:51' created_by: '300621' created_by_uri: '' estimated_completion: null job_id: 111111l470 percentage_complete: 100 reference: null response: /job/111111l1177306/response.json response_within_retention: true status: complete time_elapsed: 0 update: /job/111111l1177306.json schema: properties: execution_time: type: string job: properties: completed_at: nullable: true type: string created_at: type: string created_by: description: ID of the user who created the job type: string created_by_uri: type: string estimated_completion: nullable: true type: string job_id: description: ID of the job type: string percentage_complete: type: number reference: nullable: true type: string response: description: The raw response nullable: true type: string response_within_retention: type: boolean status: enum: - complete - created - active type: string time_elapsed: type: number update: description: The update URI nullable: true type: string type: object type: object description: OK '400': content: application/json; charset=utf-8: examples: response: value: error: message: Requested action around TQs that does not exists type: '400' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Bad Request tags: - Campaign Transaction Queries description: Process multiple Transaction Queries in a single API call. The same rules as approving, rejecting and pending single Transaction Queries apply. The actions are processed asynchronously and the Job endpoint must be polled to find out when all have been completed. operationId: Bulk process Transaction Queries requestBody: content: application/json: schema: example: transaction_queries: - new_expected_commission: 13.45 new_reason: Example reason new_state: pending transaction_query_id: 1l1000532 properties: transaction_queries: items: properties: new_expected_commission: description: expected commission value after the state change type: number new_reason: description: reason for the state change type: string new_state: $ref: '#/components/schemas/Transaction_Query_State' transaction_query_id: description: ID of the Transaction Query type: string type: array type: object summary: Bulk processing of Transaction Queries /campaign/{campaign_id}/tq_reasons: get: parameters: - description: ID of a Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: count: 1 execution_time: 0.08001 seconds transaction_query_reasons: - transaction_query_reason: campaign_id: 10l176 created_at: '2017-01-01 00:00:00' reason: Example reason transaction_query_reason_id: 111111l3 schema: properties: count: type: number execution_time: type: string transaction_query_reasons: items: $ref: '#/components/schemas/Transaction_Query_Reason' type: array type: object description: OK tags: - Transaction Query Reasons description: Return the details of all saved Transaction Query Reasons. operationId: List Transaction Query Reasons summary: List Transaction Query Reasons for a Campaign post: parameters: - description: ID of a Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.08001 seconds transaction_query_reason: campaign_id: 10l176 created_at: '2017-01-01 00:00:00' reason: Example reason transaction_query_reason_id: 111111l3 schema: $ref: '#/components/schemas/Transaction_Query_Reason' description: OK '400': content: application/json; charset=utf-8: examples: response: value: error: fields: {} message: Reason already exists type: Validation Fail schema: properties: error: properties: fields: properties: {} type: object message: type: string type: type: string type: object type: object description: Bad Request tags: - Transaction Query Reasons description: Create a new saved Transaction Query reason. operationId: Create a Transaction Query Reason requestBody: content: application/json: schema: example: reason: Example reason properties: reason: description: The reason for rejecting a Transaction Query type: string required: - reason type: object summary: Create a Transaction Query Reason for a Campaign /campaign/{campaign_id}/tq_reasons/{transaction_query_reason_id}/delete: post: parameters: - description: ID of a Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the Transaction Query Reason example: 111111l3 in: path name: transaction_query_reason_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.08001 seconds transaction_query_reason: deleted: 'true' schema: properties: execution_time: type: string transaction_query_reason: properties: deleted: type: string type: object type: object description: OK '404': content: application/json; charset=utf-8: examples: response: value: error: message: Transaction Query Reason not found type: '404' schema: properties: error: properties: message: type: string type: type: string type: object type: object description: Not Found tags: - Transaction Query Reasons description: Delete a saved Transaction Query Reason for a Campaign. operationId: Delete a Transaction Query Reason summary: Delete a Transaction Query Reason for a Campaign /user/advertiser/{advertiser_id}/invoice: get: parameters: - description: ID of the Brand example: 10l110 in: path name: advertiser_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: invoices: - invoice: average_conversion_age: 14 campaign_id: 10l176 creation_date: '2015-12-14 22:58:25' currency: GBP download: null invoice_id: 1101l1536 invoice_net_value: 770.84 invoice_reference: I-10l176-1101l1536 invoice_total_value: 770.84 invoice_vat_value: 0 invoiced: All item_download: null merchant_invoice_id: null paid_currency: GBP payment_date: '' payment_due_by_date: '' payment_reference: null publisher_commission: 700.76 publisher_override: 70.08 set_end_date: '2015-12-09' set_start_date: '2015-08-30' set_timezone: Australia/Sydney status: created vat_rate: 0 schema: properties: invoices: items: $ref: '#/components/schemas/Invoice_Wrapper' type: array type: object description: OK tags: - Invoices description: View all Invoices that have been created. operationId: List all Invoices summary: List all Invoices /user/advertiser/{advertiser_id}/invoice/{invoice_id}: get: parameters: - description: ID of the Brand example: 10l110 in: path name: advertiser_id required: true schema: type: string - description: ID of the Invoice example: 1101l1536 in: path name: invoice_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: invoice: average_conversion_age: 14 campaign_id: 10l176 creation_date: '2015-12-14 22:58:25' currency: GBP download: null invoice_id: 1101l1536 invoice_net_value: 770.84 invoice_reference: I-10l176-1101l1536 invoice_total_value: 770.84 invoice_vat_value: 0 invoiced: All item_download: null merchant_invoice_id: null paid_currency: GBP payment_date: '' payment_due_by_date: '' payment_reference: null publisher_commission: 700.76 publisher_override: 70.08 set_end_date: '2015-12-09' set_start_date: '2015-08-30' set_timezone: Australia/Sydney status: created vat_rate: 0 schema: $ref: '#/components/schemas/Invoice_Wrapper' description: OK tags: - Invoices description: View an individual Invoice. operationId: Retrieve an Invoice summary: Retrieve an Invoice /campaign/{campaign_id}/custom_terms/: parameters: - name: campaign_id in: path description: ID of the campaign examples: - 10l176 required: true schema: type: string post: operationId: Create Custom Terms and Conditions tags: - Custom Terms and Conditions summary: Create Custom Terms and Conditions description: Creates Custom Terms and Conditions for a given campaign and associates them with the provided partners. requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object properties: publisher_id: type: array description: a list of partner ids to associate with the custom terms and conditions. The list needs to contain at least one valid partner id. items: type: string title: type: string description: title of the custom terms and conditions terms: type: string description: the custom terms and conditions content locale: $ref: '#/components/schemas/Locale' required: - publisher_id - title - terms example: publisher_id: - '21' - '250001' - '3' - '300009' - 4d00ecdbe65e6 - 4d0122781f1f6 - 4d012e7a77288 title: Terms and conditions title terms: Terms and conditions content locale: pl responses: '201': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Custom Terms Response allOf: - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/schema/allOf/0' - properties: custom_terms: type: array items: $schema: http://json-schema.org/draft-04/schema title: Campaign Custom Terms and Conditions Entity type: object properties: campaign_custom_terms_and_conditions_id: type: string description: Entity id eg `111111l43` title: type: string description: Terms and conditions title terms: type: string description: Terms and conditions content created: type: string description: eg `2019-05-29 09:18:17` campaign_id: type: string description: ID of associated campaign eg `10l176` locale: $ref: '#/components/schemas/Locale' active: type: string description: '`y` or `n`' additionalProperties: false example: execution_time: 1.05973 seconds custom_terms: - campaign_custom_terms_and_conditions_id: 111111l43 title: Terms and conditions title terms: Terms and conditions content created: '2019-05-29 09:18:17' campaign_id: 10l176 locale: pl active: y '400': description: Validation Fail content: application/json: schema: $schema: http://json-schema.org/draft-04/schema title: Validation Errors type: object properties: error: properties: message: string type: string fields: type: array items: type: string example: error: message: Locale is invalid type: Validation Fail fields: - locale get: operationId: List Terms and Conditions for a given Campaign tags: - Custom Terms and Conditions summary: List All Custom Terms and Conditions for given campaign description: List All Custom Terms and Conditions for given campaign responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Custom Terms Response allOf: - $schema: http://json-schema.org/draft-04/schema type: object title: Custom Terms Empty Response properties: execution_time: type: string description: Script execution time eg `1.05973 seconds` custom_terms: type: array description: Data array additionalProperties: false - properties: custom_terms: type: array items: $schema: http://json-schema.org/draft-04/schema title: Campaign Custom Terms and Conditions Entity type: object allOf: - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/post/responses/201/content/application~1json/schema/allOf/1/properties/custom_terms/items' - type: object properties: publishers: type: array items: type: string description: An array of publisher_id values eg `111111l43` additionalProperties: false example: execution_time: 1.05973 seconds custom_terms: - campaign_custom_terms_and_conditions_id: 111111l43 title: Terms and conditions title terms: Terms and conditions content created: '2019-05-29 09:18:17' campaign_id: 10l176 locale: pl active: y publishers: [] /campaign/{campaign_id}/custom_terms/{terms_id}?{download=true}: parameters: - name: campaign_id in: path description: ID of the campaign examples: - 10l176 required: true schema: type: string - name: terms_id in: path description: ID of Campaign Terms and Conditions examples: - 1111l123 required: true schema: type: string - name: download in: path description: Use this query string parameter to indicate the terms and conditions should be downloaded as a file examples: - true required: false schema: type: string get: operationId: readCustomTerms tags: - Campaign Terms and Conditions summary: Retrieve Campaign Terms and Conditions description: Retrieve the Campaign Terms and Conditions for a given Terms and Conditions id. You can download them by specifying the `download=true` query string parameter. responses: '200': description: Success content: application/json: schema: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/post/responses/201/content/application~1json/schema' example: execution_time: 1.05973 seconds custom_terms: - campaign_custom_terms_and_conditions_id: 111111l43 title: Terms and conditions title terms: Terms and conditions content created: '2019-05-29 09:18:17' campaign_id: 10l176 locale: pl active: y /campaign/{campaign_id}/custom_terms/publisher/{publisher_id}: parameters: - name: campaign_id in: path description: ID of the campaign examples: - 10l176 required: true schema: type: string - name: publisher_id in: path description: ID of the Partner examples: - 10l176 required: true schema: type: string get: operationId: readPartnerCampaignCustomTerms tags: - Custom Terms and Conditions summary: List Partner's Terms and Conditions for a capaign. description: List Terms and Conditions for a Partner on the specified campaign. responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Custom Terms Response allOf: - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/schema/allOf/0' - properties: custom_terms: type: array items: $schema: http://json-schema.org/draft-04/schema title: Campaign Custom Terms and Conditions Entity type: object allOf: - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/post/responses/201/content/application~1json/schema/allOf/1/properties/custom_terms/items' - properties: publisher_id: type: string description: ID of a partner approved: type: string agreed_latest_terms: type: string status: type: string additionalProperties: false example: execution_time: 1.05973 seconds custom_terms: - campaign_custom_terms_and_conditions_id: 111111l43 title: Terms and conditions title terms: Terms and conditions content created: '2019-05-29 09:18:17' campaign_id: 10l176 locale: pl active: y publisher_id: '1' approved: 'null' agreed_latest_terms: n status: a /campaign/{campaign_id}/custom_terms/{custom_terms_id}: parameters: - name: campaign_id in: path description: ID of the Campaign examples: - 10l176 required: true schema: type: string - name: custom_terms_id in: path description: Id of the Campaign Terms and Conditions to delete examples: - 1111l123 required: true schema: type: string delete: operationId: deleteCampaignCustomTerms tags: - Custom Terms and Conditions summary: Delete specific Custom Terms and Conditions description: Delete Campaign Terms and Conditions for a given campaign. responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Custom Terms Response allOf: - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/schema/allOf/0' - properties: custom_terms: type: array items: type: object properties: removed_terms: type: integer description: Number of deleted entities additionalProperties: false example: execution_time: 1.05973 seconds custom_terms: - removed_terms: 1 '404': description: Failure content: application/json: schema: $schema: http://json-schema.org/draft-04/schema title: Validation Errors type: object properties: error: type: object properties: message: type: string type: type: string example: error: message: Terms with given id (111111l3) does not exist type: '404' /campaign/{campaign_id}/custom_terms/custom_terms_id/association: parameters: - name: campaign_id in: path description: ID of the Campaign examples: - 10l176 required: true schema: type: string - name: custom_terms_id in: path description: ID of Campaign Terms and Conditions to associate with a list of Partners examples: - 1111l123 required: true schema: type: string post: operationId: createAssocCampaignCustomTerms tags: - Custom Terms and Conditions summary: Associate Custom Terms and Conditions with Partners description: Associate the Custom Terms and Conditions with a list of Partners. requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object properties: publisher_id: type: array description: IDs of Partners items: type: string required: - publisher_id example: publisher_id: - 4d00ecdbe65e6 - 4d0122781f1f6 - 4d012e7a77288 responses: '200': description: Success content: application/json: schema: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/schema' example: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/example' '404': description: Failure content: application/json: schema: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1%7Bcustom_terms_id%7D/delete/responses/404/content/application~1json/schema' example: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1%7Bcustom_terms_id%7D/delete/responses/404/content/application~1json/example' delete: operationId: deleteAssocCampaignCustomTerms tags: - Custom Terms and Conditions summary: Remove associations between the Custom Terms and Conditions and Partners description: Remove associations between the Custom Terms and Conditions and a list of Partners. If all associations are removed successfully a `200 OK` status code response is returned. In the cases where there were errors a `207 Multi-status` response is returned and the body of the response will contain the list of errors for the failed ones. requestBody: content: application/json: schema: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1custom_terms_id~1association/post/requestBody/content/application~1json/schema' example: publisher_id: - 4d00ecdbe65e6 - 4d0122781f1f6 - 4d012e7a77288 responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Custom Terms Response allOf: - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/schema/allOf/0' - properties: custom_terms: type: array items: type: object properties: removed_associations: type: integer description: Number of deleted entities additionalProperties: false example: execution_time: 1.05973 seconds custom_terms: - removed_associations: 1 '207': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Custom Terms Response allOf: - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/schema/allOf/0' - properties: custom_terms: type: array items: type: object properties: removed_associations: type: integer description: Number of deleted entities - $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1%7Bcustom_terms_id%7D/delete/responses/404/content/application~1json/schema' additionalProperties: false example: execution_time: 1.05973 seconds custom_terms: - removed_associations: 1 errors: - Terms with given id (111111l3) does not exist '404': description: Failure content: application/json: schema: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1%7Bcustom_terms_id%7D/delete/responses/404/content/application~1json/schema' example: $ref: '#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1%7Bcustom_terms_id%7D/delete/responses/404/content/application~1json/example' /v2/campaigns/{campaignId}/commissions: get: operationId: get-commissions tags: - Commissions summary: List Commissions description: 'This endpoint lists all upcoming and currently active standard commissions ' parameters: - in: path name: campaignId description: The ID of the campaign to list the commissions for required: true schema: type: string - in: query name: at description: The date and time to show active commissions for. If not set defaults to now. required: false schema: type: string format: date-time example: '2023-05-04T12:00:00+00:00' responses: '200': description: Commission List content: application/json: schema: type: object title: Commissions properties: count: type: integer minimum: 0 example: 1 commissions: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema' additionalProperties: false post: operationId: create-commission tags: - Commissions summary: Create Commission description: 'This endpoint creates a new commission ' parameters: - in: path name: campaignId description: The ID of the campaign to list the commissions for required: true schema: type: string requestBody: required: true content: application/json: schema: type: object title: Commissions Create properties: description: type: string maxLength: 300 start_date: type: string format: date-time description: The Start Date of the Commission end_date: type: - string - 'null' nullable: true format: date-time description: The End Date of the Commission commission_based_on_field: type: - string - 'null' nullable: true description: The tracking field used to calculate publisher commission default: value meta_fields: type: array items: title: Meta Fields oneOf: - title: Meta Field Rules allOf: - type: object title: Meta Field properties: name: type: string description: The name of the meta field example: category required: - name - type: object properties: rules: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items/allOf/1/properties/rules/items' required: - rules - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/meta_fields/items' rates: type: array minItems: 1 items: type: object title: Commission Rate properties: id: type: string description: The ID of the Partner, Group or Campaign this commission is assigned to type: title: Commission Rate Types description: These values are internally managed and represent the level of the Commission type: string enum: - publisher - group - campaign performance_value: type: number minimum: 0 description: The value to be rewarded based on selected Performance Measurement performance_model: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/performance_model' cookie_period: type: integer minimum: 0 maximum: 31536000 description: The cookie period defined in seconds. If not specified, campaign default will be used. required: - id - type - performance_model - performance_value additionalProperties: false additionalProperties: false required: - description - start_date - rates responses: '201': description: Commission Create content: application/json: schema: properties: commission: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema' /v2/campaigns/{campaignId}/commissions/{commissionId}: parameters: - in: path name: campaignId description: The ID of the campaign the commission belongs to required: true schema: type: string - in: path name: commissionId description: The ID of the commission to retrieve required: true schema: type: string get: operationId: get-commission summary: Get Commission description: Get the given commission parameters: - in: query name: include description: 'The historical edits will be shown under the history.data attribute when set to ''history''. The endpoint will also return v1 Commissions when set to ''v1''" ' required: false schema: type: string enum: - history - v1 - in: query name: at description: The date and time to show active commissions for. If not set defaults to now. required: false schema: type: string format: date-time example: '2023-05-04T12:00:00+00:00' tags: - Commissions responses: '200': description: Commission Found content: application/json: schema: type: object title: Commission properties: commission: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema' history: type: object title: Commission History properties: data: type: array description: Audit data of the commission items: {} required: - data additionalProperties: false patch: operationId: update-commission summary: Update Commission description: 'Update the given commission. If it is currently active it will be retired and a new commission will be set up with the updated configuration. ' tags: - Commissions requestBody: content: application/json: schema: type: object title: Commission Update properties: description: type: string maxLength: 300 start_date: type: string format: date-time description: The Start Date of the Commission end_date: type: - string - 'null' nullable: true format: date-time description: The End Date of the Commission commission_based_on_field: type: - string - 'null' nullable: true description: The tracking field used to calculate partner commission default: value meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions/post/requestBody/content/application~1json/schema/properties/meta_fields/items' rates: type: array minItems: 1 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions/post/requestBody/content/application~1json/schema/properties/rates/items' additionalProperties: false responses: '200': description: Commission Updated content: application/json: schema: properties: commission: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema' /v2/campaigns/{campaignId}/commissions/{commissionId}/migrate: post: operationId: migrate-commission tags: - Commissions summary: Migrate Commission description: 'This endpoint migrates a given V1 Commission to a V2 Commission ' parameters: - in: path name: campaignId description: The ID of the campaign the commission belongs to required: true schema: type: string - in: path name: commissionId description: The ID of the commission to migrate required: true schema: type: string responses: '200': description: Commission Migrated content: application/json: schema: properties: commission: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema' /v2/campaigns/{campaignId}/commissions/{commissionId}/retire: post: operationId: retire-commission tags: - Commissions summary: Retire Commission description: 'This endpoint retires a given Commission. ' parameters: - in: path name: campaignId description: The ID of the campaign the commission belongs to required: true schema: type: string - in: path name: commissionId description: The ID of the commission to retire required: true schema: type: string responses: '200': description: Commission Retired content: application/json: schema: type: object title: Commission properties: id: type: string description: The ID of the Commission description: type: string start_date: type: - string - 'null' nullable: true format: date-time description: The Start Date of the Commission end_date: type: - string - 'null' nullable: true format: date-time description: The End Date of the Commission last_modified: allOf: - type: object title: Last Modified By properties: id: type: string description: The ID of the user to last modify this item username: type: string description: The Username of the user to last modify this item date: type: string nullable: true format: date-time - description: The last modified details of the Commission commission_based_on_field: type: string description: The tracking field used to calculate partner commission meta_fields: type: array items: title: Meta Field Rules allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/meta_fields/items' - type: object properties: rules: type: array items: type: object title: Meta Field Rule description: Meta Field Rule with operator and values. example: operator: EQUALS value: clothing oneOf: - title: Exact Match properties: operator: description: Operator used to evaluate the meta field value is an exact match. type: string enum: - EQUALS example: EQUALS value: title: Meta Field Value description: Meta field matching value. type: - string - number - title: Contains properties: operator: description: Operator used to test the meta field value against part of a string or numeric value. type: string enum: - STARTS_WITH - ENDS_WITH - CONTAINS example: STARTS_WITH value: $ref: '#/paths/~1campaign~1%7BcampaignId%7D~1optimisation~1voucher~1commission/post/responses/200/content/application~1json/schema/properties/voucher_commission/properties/meta_fields/items/properties/rules/items/oneOf/0/properties/value' - title: Comparison properties: operator: description: Comparison operator used to test a numeric meta field value. Values are inclusive. type: string enum: - GREATER_THAN - LESS_THAN example: GREATER_THAN value: title: Meta Field Value description: Meta field matching value. type: number - title: Between properties: operator: description: Match the meta field value falls within the specified range. type: string enum: - BETWEEN value: description: The lower and upper bounds of the range as an array. Values are inclusive. minItems: 2 maxItems: 2 type: array items: title: Meta Field Value description: Meta field matching value. type: number example: - 0 - 50 - title: One Of properties: operator: description: Operator used to match against a set of values. The meta field value must exactly match one of the values in the array. type: string enum: - ONE_OF value: description: A list of values to match against. minItems: 1 type: array items: title: Meta Field Value description: Meta field matching value. type: string example: - accessories - clothing - shoes required: - operator - value required: - rules status: title: Commission Status description: These values are internally managed and represent the statue of the Commission type: string enum: - ACTIVE - RETIRED - DELETED - SCHEDULED rates: type: array items: type: object title: Commission Rate properties: id: type: string description: The ID of the Partner, Group or Campaign this commission is assigned to type: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions/post/requestBody/content/application~1json/schema/properties/rates/items/properties/type' name: type: string description: The name of the Partner or Group. In the case of Voucher commissions this will be Voucher Code performance_value: type: number description: The value to be rewarded based on selected Performance Measurement performance_model: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/performance_model' cookie_period: type: integer nullable: true minimum: 0 maximum: 31536000 description: The cookie period defined in seconds. If not specified, campaign default will be used. additionalProperties: false version: type: integer description: Commission version. Only applicable when requesting V1 commissions. required: - id - description - start_date - end_date - last_modified - meta_fields - status - rates '204': description: Commission Deleted /v2/campaigns/{campaignId}/commissions/all.csv: get: operationId: get-commission-csv-download tags: - Commissions CSV Download description: 'Request a CSV for a Commission report which includes all individual items defined for the Campaign. Each item represents a commission type of default, standard, promotional or voucher commission and rates. ' summary: CSV Download. parameters: - in: path name: campaignId description: The ID of the campaign for the commissions required: true schema: type: string - in: query name: start_date_time description: Limits list to commissions active at/from this date required: false schema: type: string format: datetime - in: query name: end_date_time description: Limits list to commissions active until this date required: false schema: type: string format: datetime - in: query name: type description: Limits list to commissions of specified types required: false schema: type: string enum: - default - standard - promotional - voucher - in: query name: status description: Limits list to commissions with specified status required: false schema: type: string enum: - retired - active - scheduled responses: '200': description: Commissions CSV Download content: text/csv: examples: response: value: 'commission_group_id,commission_id,commission_type,scope,campaign_id,group_id,group_name,publisher_id,publisher_name,voucher_id,voucher_code,group_limit,start_date_time,end_date_time,status,name,performance_model,commission,commission_based_on_field,cookie_period_seconds,dynamic_sut,created,created_by_id,created_by_name,last_modified,last_modified_by,last_modified_by_name 1111111l1,1111111l3,promotional,publisher,,,,111111l9,test_publisher,,,,"2023-05-05 16:00:00","2023-09-30 00:00:00",ACTIVE,"Test Promotional Commission","% CPA",10.0000,,,,,,,,promosku,,,,avalue,"2023-05-05 14:46:54",111111l1,user_name,"2023-05-05 14:46:54",111111l1,user_name ' /v2/campaigns/{campaignId}/commissions/promotions: get: operationId: get-promotional-commissions tags: - Promotional Commissions summary: List Promotional Commissions description: 'This endpoint lists all active and scheduled promotional commissions for the given campaign. ' parameters: - in: path name: campaignId description: The ID of the campaign to list the promotional commissions for required: true schema: type: string - in: query name: at description: Check the promotional commissions for a given moment required: false example: '2021-07-02T12:00:00+01:00' schema: type: string responses: '200': description: Promotional Commission List content: application/json: schema: type: object title: Promotional Commissions properties: promotions: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/responses/201/content/application~1json/schema/properties/promotion' post: operationId: create-promotional-commission tags: - Promotional Commissions summary: Create Promotional Commission description: 'This creates a new promotional commission for the given campaign ' parameters: - in: path name: campaignId description: The ID of the campaign to create the promotional commission for required: true schema: type: string requestBody: required: true content: application/json: schema: type: object title: Promotional Commission properties: description: type: string performance_value: type: number description: The value to be rewarded based on selected Performance Measurement performance_model: title: Performance Model description: Model used to calculate Partner commission type: string enum: - fixed_cpa - percentage_cpa - cpc start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The Start Date of the Promotional Commission end_date: allOf: - title: Date Time type: string nullable: true pattern: ^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}|null)$ - description: The End Date of the Promotional Commission cookie_period: type: integer minimum: 0 maximum: 31536000 description: The cookie period defined in seconds commission_based_on_field: type: string description: The tracking field used to calculate partner commission meta_fields: type: array items: type: object title: Meta Field Values description: Meta Field with assigned values allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions/post/requestBody/content/application~1json/schema/properties/meta_fields/items/oneOf/0/allOf/0' - properties: values: description: An array of the values of a meta field type: array items: type: string title: Meta Field Value example: - clothing required: - values publishers: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/publishers/items' groups: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/groups/items' additionalProperties: false required: - performance_value - performance_model - start_date responses: '201': description: Promotional Commission Created content: application/json: schema: type: object properties: promotion: type: object title: Promotional Commission properties: id: type: string description: type: string performance_value: type: number description: The value to be rewarded based on selected Performance Measurement performance_model: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/performance_model' last_modified_by: type: string last_modified: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The date on which the commission was last modified start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The Start Date of the Promotional Commission end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The End Date of the Promotional Commission cookie_period: type: integer description: The cookie period defined in seconds commission_based_on_field: type: string description: The tracking field used to calculate partner commission. This field will only be returned when Commission By Meta is enabled meta_fields: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items' publishers: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier/properties/publishers/items' groups: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier/properties/groups/items' status: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/status' required: - id - description - performance_value - performance_model - last_modified_by - last_modified - start_date - end_date - cookie_period - meta_fields - publishers - groups - status /campaign/{campaignId}/optimisation/voucher/commission: get: operationId: get-voucher-commissions tags: - Voucher Commissions summary: List Voucher Commissions description: 'This endpoint lists all active and scheduled Voucher commissions for the given campaign. ' parameters: - in: path name: campaignId description: The ID of the campaign to list the Voucher commissions for required: true example: 11111l1 schema: type: string - in: query name: at description: Check the Voucher commissions for a given moment required: false example: '2021-07-02T12:00:00+01:00' schema: type: string responses: '200': description: Voucher Commission List content: application/json: schema: title: Voucher List Response type: object description: Voucher List Object example: count: '1' execution_time: 0.30000 seconds voucher_commissions: - description: example end_date: '2023-10-01 00:00:00' group_limit: id: 111111l1 name: example id: 111111l1 last_modified: '2023-10-01 00:00:00' last_modified_by: 111111l1 meta_fields: - name: sku value: - '1' weight: 1 performance_model: fixed_cpa performance_value: 20 start_date: '2023-10-01 00:00:00' status: SCHEDULED voucher_codes: - code: example-code description: example end_date: '2023-10-01 00:00:00' id: 111111l1 start_date: '2023-10-01 00:00:00' groups: - id: 111111l1 name: example properties: count: type: integer execution_time: type: string voucher_commissions: type: array items: type: object title: Voucher Commission properties: description: type: string end_date: type: string format: date-time group_limit: type: - object - 'null' properties: id: type: string name: type: string id: type: string last_modified: type: string format: date-time last_modified_by: type: string format: date-time meta_fields: type: - array - 'null' items: type: object properties: name: type: string value: type: - string - integer weight: type: integer rules: type: array items: type: object $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items/allOf/1/properties/rules/items' performance_model: type: string performance_value: type: number start_date: type: string format: date-time status: type: string voucher_codes: type: array items: type: object properties: code: type: string description: type: - string - 'null' end_date: type: - string - 'null' format: date-time id: type: string start_date: type: string format: date-time groups: type: - array - 'null' items: type: object properties: id: type: string name: type: string post: operationId: post-voucher-commission tags: - Voucher Commissions summary: Create Voucher Commission description: This endpoint saves a given Voucher Commission parameters: - in: path name: campaignId description: The ID of the campaign the voucher commission belongs to required: true example: 11111l1 schema: type: string requestBody: required: true content: application/json: schema: title: Voucher Commission type: object example: description: example end_date: '2023-10-01 00:00:00' start_date: '2023-10-01 00:00:00' group_limit_id: 111111l1 meta_fields: - name: sku value: '1' performance_model: fixed_cpa performance_value: 20 voucher_codes: - 111111l1 - 111111l2 properties: description: type: - string - 'null' start_date: type: string format: date-time end_date: type: - string - 'null' format: date-time group_limit_id: type: - string - 'null' meta_fields: type: array items: type: object properties: name: type: string value: type: - string - integer voucher_codes: type: array items: type: string performance_value: type: integer performance_model: type: string responses: '200': description: Save Voucher Commission content: application/json: schema: title: Voucher Commission type: object example: execution_time: 0.30000 seconds voucher_commission: description: example end_date: '2023-10-01 00:00:00' group_limit: id: 111111l1 name: example id: 111111l1 last_modified: '2023-10-01 00:00:00' last_modified_by: 111111l1 meta_fields: - name: sku value: - '1' weight: 1 rules: - operator: EQUALS value: '1' performance_model: fixed_cpa performance_value: 20 start_date: '2020-01-01 00:00:00' status: SCHEDULED voucher_codes: - code: example-code description: example end_date: '2023-10-01 00:00:00' id: 111111l1 start_date: '2023-10-01 00:00:00' groups: - id: 111111l1 name: example properties: execution_time: type: string voucher_commission: type: object $ref: '#/paths/~1campaign~1%7BcampaignId%7D~1optimisation~1voucher~1commission/get/responses/200/content/application~1json/schema/properties/voucher_commissions/items' /campaign/{campaignId}/optimisation/voucher/commission/{commissionId}: get: operationId: get-voucher-commission tags: - Voucher Commissions summary: Show Voucher Commissions description: 'This endpoint shows an active or scheduled Voucher commission for the given campaign. ' parameters: - in: path name: campaignId description: The ID of the campaign to list the Voucher commissions for required: true example: 11111l1 schema: type: string - in: path name: commissionId description: The ID of the commission to edit the Voucher commissions for required: true example: 11111l1 schema: type: string responses: '200': description: Voucher Commission Edit content: application/json: schema: title: Voucher Show Response type: object description: Voucher Show Object example: execution_time: 0.30000 seconds voucher_commission: description: example end_date: '2023-10-01 00:00:00' group_limit: id: 111111l1 name: example id: 111111l1 last_modified: '2023-10-01 00:00:00' last_modified_by: 111111l1 meta_fields: - name: sku value: - '1' weight: 1 performance_model: fixed_cpa performance_value: 20 start_date: '2023-10-01 00:00:00' status: SCHEDULED voucher_codes: - code: example-code description: example end_date: '2023-10-01 00:00:00' id: 111111l1 start_date: '2023-10-01 00:00:00' groups: - id: 111111l1 name: example properties: execution_time: type: string voucher_commission: type: object $ref: '#/paths/~1campaign~1%7BcampaignId%7D~1optimisation~1voucher~1commission/get/responses/200/content/application~1json/schema/properties/voucher_commissions/items' put: operationId: get-voucher-commissions tags: - Voucher Commissions summary: Edit Voucher Commissions description: 'This endpoint edits all active and scheduled Voucher commission for the given campaign. ' parameters: - in: path name: campaignId description: The ID of the campaign to list the Voucher commissions for required: true example: 11111l1 schema: type: string - in: path name: commissionId description: The ID of the commission to edit the Voucher commissions for required: true example: 11111l1 schema: type: string requestBody: required: true content: application/json: schema: title: Voucher Commission type: object example: description: example end_date: '2023-10-01 00:00:00' start_date: '2023-10-01 00:00:00' meta_fields: - name: sku value: '1' performance_model: fixed_cpa performance_value: 20 voucher_codes: - 111111l1 - 111111l2 properties: description: type: - string - 'null' start_date: type: string format: date-time end_date: type: - string - 'null' format: date-time meta_fields: type: array items: type: object properties: name: type: string values: type: - string - integer performance_value: type: number performance_model: type: string voucher_codes: type: array items: type: string responses: '200': description: Voucher Commission Edit content: application/json: schema: title: Voucher Edit Response type: object description: Voucher Edit Object example: execution_time: 0.30000 seconds voucher_commission: description: example end_date: '2023-10-01 00:00:00' group_limit: id: 111111l1 name: example id: 111111l1 last_modified: '2023-10-01 00:00:00' last_modified_by: 111111l1 meta_fields: - name: sku value: - '1' weight: 1 performance_model: fixed_cpa performance_value: 20 start_date: '2023-10-01 00:00:00' status: SCHEDULED voucher_codes: - code: example-code description: example end_date: '2023-10-01 00:00:00' id: 111111l1 start_date: '2023-10-01 00:00:00' groups: - id: 111111l1 name: example properties: execution_time: type: string voucher_commission: type: object $ref: '#/paths/~1campaign~1%7BcampaignId%7D~1optimisation~1voucher~1commission/get/responses/200/content/application~1json/schema/properties/voucher_commissions/items' delete: operationId: delete-voucher-commission tags: - Voucher Commissions summary: Delete Scheduled Voucher Commission description: This endpoint deletes a scheduled Voucher Commission. Active Voucher Commissions should be retired. parameters: - in: path name: campaignId description: The ID of the campaign the voucher commission belongs to required: true example: 11111l1 schema: type: string - in: path name: commissionId description: The ID of the commission to retire the Voucher commissions for required: true example: 11111l1 schema: type: string responses: '200': description: Delete scheduled Voucher Commission content: application/json: schema: title: Delete Active Voucher Commission type: object example: execution_time: 0.30000 seconds voucher_commission: description: example end_date: '2023-10-01 00:00:00' group_limit: id: 111111l1 name: example id: 111111l1 last_modified: '2023-10-01 00:00:00' last_modified_by: 111111l1 meta_fields: - name: sku value: - '1' weight: 1 performance_model: fixed_cpa performance_value: 20 start_date: '2023-10-01 00:00:00' status: DELETED voucher_codes: - code: example-code description: example end_date: '2023-10-01 00:00:00' id: 111111l1 start_date: '2023-10-01 00:00:00' groups: - id: 111111l1 name: example properties: execution_time: type: string voucher_commission: type: object $ref: '#/paths/~1campaign~1%7BcampaignId%7D~1optimisation~1voucher~1commission/get/responses/200/content/application~1json/schema/properties/voucher_commissions/items' '400': description: Delete active Voucher Commission content: application/json: schema: title: Retire Scheduled Voucher Commission type: object example: errors: - type: Validation Exception messages: commission_not_active: Voucher Commission status must be 'SCHEDULED' errors_count: 1 properties: errors_count: integer errors: type: array items: type: object properties: type: type: string messages: type: object properties: commission_not_active: commission_not_active: string /campaign/{campaignId}/optimisation/voucher/commission/{commissionId}/retire: post: operationId: retire-voucher-commission tags: - Voucher Commissions summary: Retire Active Voucher Commission description: This endpoint retires an active Voucher Commission. Scheduled Voucher Commissions should be deleted. parameters: - in: path name: campaignId description: The ID of the campaign the voucher commission belongs to required: true example: 11111l1 schema: type: string - in: path name: commissionId description: The ID of the commission to retire the Voucher commissions for required: true example: 11111l1 schema: type: string responses: '200': description: Retire active Voucher Commission content: application/json: schema: title: Delete Active Voucher Commission type: object example: execution_time: 0.30000 seconds voucher_commission: description: example end_date: '2023-10-01 00:00:00' group_limit: id: 111111l1 name: example id: 111111l1 last_modified: '2023-10-01 00:00:00' last_modified_by: 111111l1 meta_fields: - name: sku value: - '1' weight: 1 performance_model: fixed_cpa performance_value: 20 start_date: '2023-10-01 00:00:00' status: RETIRED voucher_codes: - code: example-code description: example end_date: '2023-10-01 00:00:00' id: 111111l1 start_date: '2023-10-01 00:00:00' groups: - id: 111111l1 name: example properties: execution_time: type: string voucher_commission: type: object $ref: '#/paths/~1campaign~1%7BcampaignId%7D~1optimisation~1voucher~1commission/get/responses/200/content/application~1json/schema/properties/voucher_commissions/items' '400': description: Retire scheduled Voucher Commission content: application/json: schema: title: Retire Active Voucher Commission type: object example: errors: - type: Validation Exception messages: commission_not_active: Voucher Commission status must be 'ACTIVE' errors_count: 1 properties: errors_count: integer errors: type: array items: type: object properties: type: type: string messages: type: object properties: commission_not_active: commission_not_active: string /v2/campaigns/{campaignId}/commissions/promotions/{promotionalId}: get: operationId: get-promotional-commission tags: - Promotional Commissions summary: Get Promotional Commission description: 'This endpoint returns the promotional commission for the given campaign and promotional commission ID. ' parameters: - in: path name: campaignId description: The ID of the campaign the promotional commission belongs to required: true schema: type: string - in: path name: promotionalId description: The ID of the promotional commission to retrieve required: true schema: type: string - in: query name: include description: The historical edits will be shown under the history.data attribute when set to 'history'. required: false schema: type: string enum: - history responses: '200': description: Promotional Commission content: application/json: schema: type: object title: Promotional Commission properties: promotion: type: object $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/responses/201/content/application~1json/schema/properties/promotion' history: type: object title: Promotional Commission History properties: data: type: array description: Audit data of the commission items: {} required: - data delete: operationId: delete-promotional-commission tags: - Promotional Commissions summary: Delete Promotional Commission description: 'This endpoint deletes a given Promotional Commission ' parameters: - in: path name: campaignId description: The ID of the campaign the promotional commission belongs to required: true schema: type: string - in: path name: promotionalId description: The ID of the promotional commission to delete required: true schema: type: string responses: '200': description: Promotional Commission Deleted patch: operationId: update-promotional-commission tags: - Promotional Commissions summary: Modify Promotional Commission description: 'Modifies the promotional commission for the given commission ID and campaign ' parameters: - in: path name: campaignId description: The ID of the campaign to update the promotional commission for required: true schema: type: string - in: path name: promotionalId description: The ID of the promotional commission to update required: true schema: type: string requestBody: required: true content: application/json: schema: type: object title: Promotional Commission properties: id: type: string description: type: string nullable: true performance_value: type: number description: The value to be rewarded based on selected Performance Measurement performance_model: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/performance_model' start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The Start Date of the Promotional Commission end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/end_date/allOf/0' - description: The End Date of the Promotional Commission cookie_period: type: integer nullable: true minimum: 0 maximum: 31536000 description: The cookie period defined in seconds commission_based_on_field: type: string description: The tracking field used to calculate partner commission meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/meta_fields/items' publishers: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/publishers/items' groups: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/groups/items' additionalProperties: false responses: '200': description: Promotional Commission Updated content: application/json: schema: type: object properties: promotion: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/responses/201/content/application~1json/schema/properties/promotion' /v2/campaigns/{campaignId}/commissions/promotions/{promotionalId}/retire: post: operationId: retire-promotional-commission tags: - Promotional Commissions summary: Retire Promotional Commission description: 'This endpoint retires a given Promotional Commission ' parameters: - in: path name: campaignId description: The ID of the campaign the promotional commission belongs to required: true schema: type: string - in: path name: promotionalId description: The ID of the promotional commission to retire required: true schema: type: string responses: '200': description: Promotional Commission Retired content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions~1%7BpromotionalId%7D/get/responses/200/content/application~1json/schema' /v2/campaigns/{campaignId}/commissions/tiers: get: operationId: get-commission-tiers tags: - Tiers summary: List Commission Tiers description: 'This endpoint lists all upcoming and currently active commission tiers for the given campaign. ' parameters: - in: path name: campaignId description: The ID of the campaign to list the commission tiers for required: true schema: type: string responses: '200': description: Commission Tier List content: application/json: schema: type: object title: Commission Tiers properties: tiers: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier' post: operationId: create-commission-tier tags: - Tiers summary: Create Commission Tier description: 'This creates a new commission tier for the given campaign ' parameters: - in: path name: campaignId description: The ID of the campaign to create the commission tier for required: true schema: type: string requestBody: required: true content: application/json: schema: type: object title: Commission Tier properties: id: type: string name: type: string start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The Start Date of the Commission Tier end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The End Date of the Commission Tier evaluation_period: type: integer description: The earliest number of seconds after the end date the Commission Tier will be rewarded. Maximum length is 86,399,999 seconds, or rather, less than 1000 days exactly minimum: 0 maximum: 86399999 reward_pending: allOf: - title: Reward Pending description: If enabled, pending conversion items can also be rewarded. type: boolean enum: - true - false - description: Will pending conversion items be rewarded reward_model: title: Reward Model description: Model used to calculate Partner rewards type: string enum: - fixed_reward - fixed_cpa - percentage_cpa performance_measurement: title: Performance Measurement description: The measurement used to calculate Partners performance type: string enum: - total_items - total_revenue meta_fields: type: array items: type: object title: Meta Field Value description: Meta Field with an assigned value allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions/post/requestBody/content/application~1json/schema/properties/meta_fields/items/oneOf/0/allOf/0' - properties: value: description: The value of meta field to look for required: - value levels: type: array minItems: 1 description: An array of Commission Tier Levels. Each Commission Tier Level's threshold must be unique. items: type: object title: Commission Tier Level properties: threshold: description: The minimum amount to be considered for this Commission Tier Level. Used in calculating Performance type: number minimum: 0.01 bonus_value: description: The amount rewarded to Partners that reach this Commission Tier Level, based on Reward Model type: number minimum: 0.01 required: - threshold - bonus_value publishers: type: array minItems: 0 items: type: string title: Partner ID groups: type: array minItems: 0 items: type: string title: Group ID additionalProperties: false required: - name - start_date - end_date - evaluation_period - reward_pending - reward_model - performance_measurement - meta_fields - levels responses: '201': description: Tier Created content: application/json: schema: type: object properties: tier: type: object title: Commission Tier properties: id: type: string name: type: string start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The Start Date of the Commission Tier end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The End Date of the Commission Tier evaluation_period: type: integer description: The earliest number of seconds after the end date the Commission Tier will be rewarded. Maximum length is 86,399,999 seconds, or rather, less than 1000 days exactly minimum: 0 maximum: 86399999 reward_pending: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/reward_pending/allOf/0' - description: Which approval statuses to reward reward_model: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/reward_model' performance_measurement: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/performance_measurement' meta_fields: type: array items: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1meta-fields/get/responses/200/content/application~1json/schema/properties/meta_fields/items/allOf/0' - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items' levels: type: array minItems: 1 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/levels/items' publishers: type: array minItems: 0 items: type: object title: Partner properties: id: type: string name: type: string required: - id - name groups: type: array minItems: 0 items: type: object title: Partner Group properties: id: type: string name: type: string required: - id - name status: title: Commission Tier Status description: These values are internally managed and represent the statue of the Commission Tier type: string enum: - ACTIVE - COMPLETED - DELETED - SCHEDULED required: - name - start_date - end_date - evaluation_period - reward_pending - reward_model - performance_measurement - meta_fields - levels - publishers - groups - status /v2/campaigns/{campaignId}/commissions/tiers/{tierId}: delete: operationId: delete-commission-tier tags: - Tiers summary: Delete Commission Tier description: 'This endpoint deletes a given Commission Tier ' parameters: - in: path name: campaignId description: The ID of the campaign to list the commission tiers for required: true schema: type: string - in: path name: tierId description: The ID of the commission tier to delete required: true schema: type: string responses: '204': description: Commission Tier Deleted patch: operationId: update-commission-tier tags: - Tiers summary: Modify Commission Tier description: 'Modifies the commission tier for the given tier ID and campaign ' parameters: - in: path name: campaignId description: The ID of the campaign to update the commission tier for required: true schema: type: string - in: path name: tierId description: The ID of the tier to update required: true schema: type: string requestBody: required: true content: application/json: schema: type: object title: Commission Tier properties: name: type: string start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The Start Date of the Commission Tier end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The End Date of the Commission Tier evaluation_period: type: integer description: The earliest number of seconds after the end date the Commission Tier will be rewarded. Maximum length is 86,399,999 seconds, or rather, less than 1000 days exactly minimum: 0 maximum: 86399999 reward_pending: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/reward_pending/allOf/0' - description: Will pending conversion items be rewarded reward_model: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/reward_model' performance_measurement: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/performance_measurement' meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/meta_fields/items' levels: type: array minItems: 1 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/levels/items' publishers: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/publishers/items' groups: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/groups/items' additionalProperties: false responses: '200': description: Tier Updated content: application/json: schema: type: object properties: tier: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier' /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions: get: operationId: get-publisher-commissions tags: - Partner Commissions summary: Get Partner Commissions description: Get Partner Commissions. Active and Scheduled Commissions will be returned parameters: - in: path name: campaignId description: The ID of the campaign for which to get partner commission rates required: true schema: type: string - in: path name: publisherId description: The ID of a partner on a campaign required: true schema: type: string - in: query name: status description: Retrieve Commissions with a specifc Status required: false schema: type: string enum: - scheduled - in: query name: type description: Retrieve Commissions of a specific Commission Type required: false schema: type: string enum: - default - campaign responses: '200': description: Partner Commissions Returned content: application/json: schema: type: object properties: commissions: type: array items: anyOf: - type: object title: Partner Commission properties: id: type: - string - 'null' nullable: true description: The ID of the Commission type: title: Commission Types description: These values represent the type of Commission being returned type: string enum: - default - campaign - promotional - voucher description: type: string start_date: type: - string - 'null' nullable: true format: date-time description: The Start Date of the Commission end_date: type: - string - 'null' nullable: true format: date-time description: The End Date of the Commission commission_based_on_field: type: string description: The tracking field used to calculate partner commission status: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/status' meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items' rates: type: array items: type: object title: Commission Rate properties: id: type: string description: The ID of the Partner, Group or Campaign this commission is assigned to scope: title: Commission Rate Scopes description: These values represent the Scope of the Commission. Used to determine commission overrides. type: string enum: - publisher - group - campaign - voucher name: type: string description: The name of the Partner, Group or Campaign. In the case of Voucher commissions this will be the Voucher Code performance_value: type: number description: The value to be rewarded based on selected Performance Measurement performance_model: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/performance_model' cookie_period: type: - integer - 'null' nullable: true minimum: 0 maximum: 31536000 description: The cookie period defined in seconds. If not specified, campaign default will be used. additionalProperties: false required: - id - scope - name - performance_value - performance_model - cookie_period minItems: 1 required: - id - type - description - start_date - end_date - status - meta_fields - rates - type: object title: Commission Tier properties: id: type: string name: type: string type: type: string enum: - tier scope: title: Commission Tier Scope description: These values are internally managed and represent the scope of the commission tier type: string enum: - publisher - group - campaign start_date: type: - string - 'null' nullable: true format: date-time description: The Start Date of the Commission Tier end_date: type: - string - 'null' nullable: true format: date-time description: The End Date of the Commission Tier performance_model: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/reward_model' performance_measurement: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/performance_measurement' status: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier/properties/status' meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/meta_fields/items' levels: type: array minItems: 1 description: An array of Commission Tier Levels. items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/levels/items' additionalProperties: false required: - id - name - type - scope - start_date - end_date - performance_model - performance_measurement - status - meta_fields - levels /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/default: get: operationId: get-publisher-commissions-default tags: - Partner Commissions summary: Get Partner Default Commissions description: Get Partner Default Commissions parameters: - in: path name: campaignId description: The ID of the campaign for which to get partner commission rates required: true schema: type: string - in: path name: publisherId description: The ID of a Partner on a campaign required: true schema: type: string responses: '200': description: Partner Default Commissions Returned content: application/json: schema: type: object properties: description: type: string performance_value: type: string performance_model: type: string last_modified_by: type: string last_modified: type: string title: Date Time pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ publishers: type: object properties: id: type: string performance_value: type: string name: type: string groups: type: object properties: id: type: string performance_value: type: string name: type: string examples: Commission: value: description: The Default Commission performance_value: '2.5' performance_model: fixed_cpa last_modified_by: '3' last_modified: '2010-01-01 12:30:00' publishers: id: 10110l2398476 performance_value: '3.25' name: Best Partner groups: id: 111001l90872354 performance_value: '3.75' name: Special Group /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/campaign: get: operationId: get-publisher-commissions-campaign tags: - Partner Commissions summary: List Partner Commissions For Specific Campaign description: 'This endpoint lists partner commissions for the given partner and campaign. ' parameters: - in: path name: publisherId description: The ID of the Partner to list commissions for required: true schema: type: string - in: path name: campaignId description: The ID of the campaign to list the Partner commissions for required: true schema: type: string responses: '200': description: Partner Commissions List content: application/json: schema: type: object properties: commissions: type: array items: type: object properties: id: type: string description: type: string performance_value: type: number description: The amount to be paid to the partner for commission. Must be greater than 0. Will be rounded to 2 decimal places. minimum: 0.01 performance_model: type: string description: The performance model by which the partner is rewarded. enum: - cpc - fixed_cpa - percentage_cpa start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' status: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/status' meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items' last_modified: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' - description: The date the campaign was last updated last_modified_by: type: string description: ID of the most recent user to modify this record. cookie_period: type: number description: Period tracking cookie will remain on users device. commission_based_on_field: type: string /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/voucher: get: operationId: get-publisher-commissions-voucher tags: - Partner Commissions summary: List Partner Voucher Commissions For Specific Campaign description: 'This endpoint lists partner voucher commissions for the given partner and campaign. ' parameters: - in: path name: publisherId description: The ID of the partner to list commissions for required: true schema: type: string - in: path name: campaignId description: The ID of the campaign to list the partner commissions for required: true schema: type: string responses: '200': description: Partner Voucher Commissions List content: application/json: schema: type: object properties: voucher_commissions: type: array items: type: object properties: id: type: string description: type: string performance_value: type: number description: The amount to be paid to the partner for commission. Must be greater than 0. Will be rounded to 2 decimal places. minimum: 0.01 performance_model: type: string description: The performance model by which the partner is rewarded. enum: - cpc - fixed_cpa - percentage_cpa start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' status: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/status' meta_fields: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/requestBody/content/application~1json/schema/properties/meta_fields/items' last_modified: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' last_modified_by: type: string description: ID of the most recent user to modify this record. voucher_codes: type: array minItems: 0 description: Voucher code details associated with this voucher commission items: type: object properties: id: type: string code: type: string description: type: string start_date: type: string end_date: type: string groups: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier/properties/groups/items' commission_based_on_field: type: string /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/promotion: get: operationId: get-publisher-commissions-promotion tags: - Partner Commissions summary: List Partner Promotional Commissions For Specific Campaign description: 'This endpoint lists partner promotional commissions for the given partner and campaign. ' parameters: - in: path name: publisherId description: The ID of the Partner to list commissions for required: true schema: type: string - in: path name: campaignId description: The ID of the campaign to list the Partner commissions for required: true schema: type: string responses: '200': description: Partner Promotional Commissions List content: application/json: schema: type: object properties: promotions: type: array items: type: object properties: id: type: string description: type: string performance_value: type: number description: The amount to be paid to the partner for commission. Must be greater than 0. Will be rounded to 2 decimal places. minimum: 0.01 performance_model: type: string description: The performance model by which the partner is rewarded. enum: - cpc - fixed_cpa - percentage_cpa start_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' end_date: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' cookie_period: type: number description: Period tracking cookie will remain on users device. commission_based_on_field: type: string status: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/status' meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items' publishers: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier/properties/publishers/items' groups: type: array minItems: 0 items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier/properties/groups/items' last_modified: allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1default/get/responses/200/content/application~1json/schema/properties/last_modified' last_modified_by: type: string description: ID of the most recent user to modify this record. /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/tier: get: operationId: get-publisher-commissions-tier tags: - Partner Commissions summary: List Partner Tiered Commissions For Specific Campaign description: 'This endpoint lists partner tiered commissions for the given partner and campaign. ' parameters: - in: path name: publisherId description: The ID of the Partner to list commissions for required: true schema: type: string - in: path name: campaignId description: The ID of the campaign to list the Partner commissions for required: true schema: type: string responses: '200': description: Partner Tiered Commissions List content: application/json: schema: type: object properties: tiers: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1tiers/post/responses/201/content/application~1json/schema/properties/tier' /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/active: get: operationId: get-active-publisher-commissions tags: - Partner Commissions summary: List Active Partner Commissions description: 'This endpoint lists all active commissions including default, standard, voucher and promotional commissions for a partner a campaign ' parameters: - in: path name: campaignId description: The ID of the campaign to list the commissions for required: true schema: type: string - in: path name: publisherId description: The ID of a Partner on a campaign required: true schema: type: string - in: query name: at description: The date and time to show the active commissions for. If not set defaults to now. required: false schema: type: string format: date-time responses: '200': description: Partner Active Commissions List content: application/json: schema: type: object properties: active_commissions: type: array items: anyOf: - type: object title: Active Partner Commissions properties: id: type: string description: The ID of the Commission type: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions/get/responses/200/content/application~1json/schema/properties/commissions/items/anyOf/0/properties/type' description: type: string start_date: type: string nullable: true format: date-time description: The Start Date of the Commission end_date: type: string nullable: true format: date-time description: The End Date of the Commission commission_based_on_field: type: string description: The tracking field used to calculate partner commission status: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/status' meta_fields: type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1%7BcommissionId%7D~1retire/post/responses/200/content/application~1json/schema/properties/meta_fields/items' rates: type: array items: type: object title: Commission Rate properties: id: type: string description: The ID of the Partner, Group or Campaign this commission is assigned to scope: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions/get/responses/200/content/application~1json/schema/properties/commissions/items/anyOf/0/properties/rates/items/properties/scope' name: type: string description: In the case of Voucher commissions this will be the Voucher Code performance_value: type: number description: The value to be rewarded based on selected Performance Measurement performance_model: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions~1promotions/post/requestBody/content/application~1json/schema/properties/performance_model' cookie_period: type: - integer - 'null' nullable: true minimum: 0 maximum: 31536000 description: The cookie period defined in seconds. If not specified, campaign default will be used. Cookie Period will not be returned for Voucher Commissions. additionalProperties: false required: - id - scope - performance_value - performance_model minItems: 1 - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions/get/responses/200/content/application~1json/schema/properties/commissions/items/anyOf/1' /v2/campaigns/{campaignId}/meta-fields: get: operationId: get-meta-fields tags: - Meta Fields summary: List Campaign Meta Fields description: 'Determine the meta fields available when filtering commissions. This endpoint returns either the default set of meta fields, or a custom set which replaces the default fields. ' parameters: - in: path name: campaignId description: The ID of the campaign to list the commission tiers for required: true schema: type: string responses: '200': description: Meta Field List content: application/json: schema: type: object title: Meta Fields properties: meta_fields: type: array items: allOf: - type: object title: Meta Field Weight description: Meta Field with weight allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1commissions/post/requestBody/content/application~1json/schema/properties/meta_fields/items/oneOf/0/allOf/0' - type: object properties: weight: type: number description: The weight of the meta field required: - weight /v2/campaigns/{campaignId}/commissions/tiers/meta-fields: get: operationId: get-tier-meta-fields tags: - Meta Fields summary: List Tier Meta Fields description: 'Returns the meta fields available when defining commission tiers. This endpoint returns campaign meta fields, plus meta fields that can be used to refine commission tiers, but not commission rates. ' parameters: - in: path name: campaignId description: The ID of the campaign to list the commission tiers for required: true schema: type: string responses: '200': description: Meta Field List content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1meta-fields/get/responses/200/content/application~1json/schema' /campaign/{campaign_id}/commission_group: get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: commission_groups: - commission_group: active: y campaign_id: 10l176 commission_group_id: 10l169 description: '' end_date_time: '2013-09-30 15:00:00' last_modified: '2015-04-10 01:59:54' name: Fansites 3 percent publishers: - 100l06 - 100l08 start_date_time: '2013-08-31 15:00:00' schema: properties: commission_groups: items: $ref: '#/components/schemas/Commission_Group_Wrapper' type: array type: object description: OK tags: - Partner Groups description: View all Partner (Commission) Groups for a campaign with all associated partners. operationId: List Partner Groups summary: List all Partner (Commission) Groups for a given campaign /campaign/{campaign_id}/commission_group/{commission_group_id}: get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the Partner (Commission) group example: 10l169 in: path name: commission_group_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: commission_group: active: y campaign_id: 10l176 commission_group_id: 10l169 description: '' end_date_time: '2013-09-30 15:00:00' last_modified: '2015-04-10 01:59:54' name: Fansites 3 percent publishers: - 100l06 - 100l08 start_date_time: '2013-08-31 15:00:00' schema: properties: commission_group: properties: active: enum: - y - n type: string campaign_id: description: ID of the campaign type: string commission_group_id: description: ID of the Partner (Commission) group type: string description: type: string end_date_time: nullable: true type: string last_modified: type: string name: type: string publishers: description: IDs of the publishers to be associated with the group start_date_time: nullable: true type: string type: object type: object description: OK tags: - Partner Groups description: Retrieves the specified Partner (Commission) Group. operationId: Retrieve a Partner Group summary: Retrieve a Partner (Commission) Group /commission_group: post: responses: '200': content: application/json; charset=utf-8: examples: response: value: commission_group: active: y campaign_id: 10l176 commission_group_id: 10l169 description: '' end_date_time: '2013-09-30 15:00:00' last_modified: '2015-04-10 01:59:54' name: Fansites 3 percent publishers: - 100l06 - 100l08 start_date_time: '2013-08-31 15:00:00' schema: properties: commission_group: properties: active: enum: - y - n type: string campaign_id: description: ID of the campaign type: string commission_group_id: description: ID of the Partner (Commission) group type: string description: type: string end_date_time: nullable: true type: string last_modified: type: string name: type: string publishers: description: IDs of the partners to be associated with the group start_date_time: nullable: true type: string required: - name - campaign_id type: object type: object description: OK tags: - Partner Groups description: Create new Partner (Commission) Groups. To add Partners into the Partner (Commission) Group pass them in a `publishers` array. operationId: Create Partner Groups requestBody: content: application/json: schema: example: commission_groups: - campaign_id: 10l176 description: '' end_date_time: '2013-09-30 15:00:00' name: Top Sites 2 percent publishers: - 100l06 - 100l08 start_date_time: '2013-08-31 15:00:00' properties: commission_groups: type: array type: object summary: Create Partner (Commission) Groups put: responses: '200': content: application/json; charset=utf-8: examples: response: value: commission_group: active: y campaign_id: 10l176 commission_group_id: 10l169 description: '' end_date_time: '2013-09-30 15:00:00' last_modified: '2015-04-10 01:59:54' name: Fansites 3 percent publishers: - 100l06 - 100l08 start_date_time: '2013-08-31 15:00:00' schema: properties: commission_group: properties: active: enum: - y - n type: string campaign_id: description: ID of the campaign type: string commission_group_id: description: ID of the Partner (Commission) group type: string description: type: string end_date_time: nullable: true type: string last_modified: type: string name: type: string publishers: description: IDs of the partners to be associated with the group start_date_time: nullable: true type: string required: - name - campaign_id type: object type: object description: OK tags: - Partner Groups description: Update Partner (Commission) Groups by referencing the `commission_group_id` in each Group object within the `commission_groups` array. operationId: Update Partner (Commission) Groups requestBody: content: application/json: schema: example: commission_groups: - campaign_id: 10l176 commission_group_id: 10l169 description: '' end_date_time: '2013-09-30 15:00:00' name: Top Sites 4 percent publishers: - 100l06 - 100l08 start_date_time: '2013-08-31 15:00:00' properties: commission_groups: type: array type: object summary: Update Partner (Commission) Groups /v2/campaigns/{campaignId}/publishers/{publisherId}/attribution: get: summary: Partner Attributions tags: - Attribution responses: '200': description: OK content: application/json: schema: description: Attribution models active for the Partner on the Campaign type: object properties: data: type: object properties: preferred_partner: type: array minItems: 1 description: Partner Preferred Date Ranges items: title: Partner Preferred Date Range type: object description: Partner Preferred Date Range properties: start_date: type: string format: date-time end_date: type: string format: date-time exclusive_codes: type: array minItems: 1 description: Partner Exclusive Codes items: title: Partner Exclusive Code type: object description: Partner Exclusive Code properties: code: title: Exclusive Code Definition type: object description: Exclusive Code Definition properties: operator: type: string enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH value: type: string minLength: 1 pattern: ^[a-zA-Z0-9]*$ start_date: type: string format: date-time end_date: type: - string - 'null' format: date-time in_cart: title: In Cart Threshold type: object description: In Cart Threshold properties: threshold: type: number description: Time in seconds that In Cart is applied for minimum: 0 maximum: 3540 split: title: Partner Split Commissioning type: object description: Partner Split Commissioning properties: initiator: type: number description: How much as a percentage the initiator receives minimum: 0 maximum: 100 contributor_fallback: type: string description: How the remaining percentage is split for a conversion without any contributors enum: - converter - initiator - split example: split converter: type: number description: How much as a percentage the converter receives minimum: 0 maximum: 100 meta: type: object properties: preferred_partner: type: boolean description: If Preferred Partner Attribution is enabled on this Campaign exclusive_codes: type: boolean description: If Exclusive Code Attribution is enabled on this Campaign operationId: get-partners-attribution description: 'Get available ongoing and upcoming attribution opportunities for the given partner. Any of the keys within the response will be excluded if they are not applicable, such as not being enabled or configured for the partner.' parameters: - schema: type: string name: campaign_id in: path required: true description: The ID of the campaign - schema: type: string name: partner_id in: path required: true description: The ID of the partner /v2/campaigns/{campaignId}/attribution: parameters: - $ref: '#/components/parameters/campaignId' get: summary: List Attribution Settings tags: - Attribution responses: '200': description: OK content: application/json: schema: title: Attribution Response type: object description: Attribution Response Object example: data: code_suppression: false preferred_partners: true exclusive_codes: true in_cart: false split: true properties: data: type: object properties: code_suppression: type: boolean description: Is Code Suppression enabled? preferred_partners: type: boolean description: Is Preferred Partners Enabled? exclusive_codes: type: boolean description: Is Exclusive Codes enabled? in_cart: type: boolean description: Is In-Cart enabled? split: type: boolean description: Is Split enabled? operationId: get-v2-attribution description: Get the status of each of the Attribution Settings patch: summary: Update Attribution Settings operationId: post-v2-attribution responses: '200': description: OK content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution/get/responses/200/content/application~1json/schema' requestBody: content: application/json: schema: title: Attribution Update Request type: object description: Attribution Update Request Object properties: code_suppression: type: boolean description: Is Code Suppression enabled? preferred_partners: type: boolean description: Is Preferred Partners Enabled? exclusive_codes: type: boolean description: Is Exclusive Codes enabled? in_cart: type: boolean description: Is In-Cart enabled? Mutually exclusive with Split split: type: boolean description: Is Split enabled? Mutually exclusive with In-Cart first_click: type: boolean description: Is First Click enabled? Mutually exclusive with In-Cart and Split description: '' tags: - Attribution description: Update the Attribution Settings /v2/campaigns/{campaignId}/attribution/suppressed-codes: parameters: - $ref: '#/components/parameters/campaignId' get: summary: List All Suppressed Codes tags: - Suppressed Code responses: '200': description: OK content: application/json: schema: title: suppressed Code Response type: object properties: data: title: Suppressed Codes type: array description: A Collection of Suppressed Codes items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1suppressed-codes/post/responses/201/content/application~1json/schema/properties/data' hypermedia: type: object required: - next properties: next: type: - string - 'null' description: The URL to call for the next set of preferred partners meta: type: object required: - enabled properties: enabled: type: boolean description: Is Suppressed Code attribution enabled on this campaign? required: - data - hypermedia - meta operationId: get-v2-attribution-suppressed-codes parameters: - schema: type: integer minimum: 0 maximum: 200 in: query name: limit description: Used to limit the response to a number of results - schema: type: integer minimum: 0 in: query name: offset description: Used to offset the results we're returning - schema: type: string pattern: ^[-a-z0-9_]++$ in: query name: query description: Search for specific codes - schema: type: string pattern: ^.*?,.*?$ example: 2020-10-01,2020-10-31 in: query name: dates description: Search for codes within a date-time range. Comma separated start and end date-times - schema: type: string example: active,scheduled,expired pattern: ^\w+(,\w+)*$ in: query name: statuses description: A comma separated list of statuses to return results for description: Show a list of all configured suppressed codes. May be filtered with several filters. post: summary: Create a Suppressed Code operationId: post-v2-campaigns-campaignId-attribution-suppressed-codes responses: '201': description: Created content: application/json: schema: title: Suppressed Code Response type: object properties: data: title: Suppressed Code type: object x-examples: Example Suppressed Code Instance: id: 1111l1 voucher_code: NEWITEM start_date: 2020-10-01T15:00:00+0100 end_date: 2020-10-05T23:59:59+0100 status: expired properties: id: type: string description: The unique ID of this Suppressed Code voucher_code: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1suppressed-codes/post/requestBody/content/application~1json/schema/properties/voucher_code/oneOf/1/allOf/0' start_date: type: string format: date-time description: The date the code is considered suppressed from end_date: type: - string - 'null' format: date-time description: The date the code is considered suppressed until. This is inclusive. status: type: string enum: - scheduled - active - expired description: The status of this Suppressed Code instance required: - id - voucher_code - start_date - end_date - status required: - data description: Create a Suppressed Code configuration tags: - Suppressed Code requestBody: content: application/json: schema: title: Suppressed Code Request type: object properties: voucher_code: oneOf: - type: string pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 description: An exact match voucher code - allOf: - title: Suppressed Code Fuzzy Value type: object description: A fuzzy matched value properties: value: type: string pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 example: SUPP-1 operator: type: string enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/requestBody/content/application~1json/schema/properties/voucher_code/oneOf/1/allOf/1' - title: Suppressed Code All Values type: object description: Suppresses all voucher codes properties: operator: type: string enum: - ALL required: - operator start_date: type: string format: date-time end_date: type: - string - 'null' format: date-time required: - voucher_code - start_date delete: summary: Delete Suppressed Codes operationId: bulk-delete-v2-campaigns-campaignId-attribution-suppressed-codes responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: type: object properties: error: type: object required: - errors properties: errors: type: array items: type: object properties: type: type: string code: type: string message: type: string required: - type - code - message code: type: integer message: type: string required: - error - code - message examples: Cannot delete active Suppressed Code: value: error: errors: - type: validation_error code: invalid_suppressed_code message: Unable to delete Suppressed Code 12344. Only scheduled Suppressed Code can be deleted. code: 400 message: Bad Request description: Delete Suppressed Codes. This is only possible if the Suppressed Codes are scheduled, otherwise an error will occur. requestBody: content: application/json: schema: title: Delete Suppressed Code Request type: object properties: suppressed_code_ids: minItems: 1 items: type: string description: The Unique ID of Suppressed Code to be deleted required: - suppressed_code_ids tags: - Suppressed Code /v2/campaigns/{campaignId}/attribution/suppressed-codes/{id}: parameters: - $ref: '#/components/parameters/campaignId' - schema: type: string example: 1001l1 name: id in: path required: true description: The ID of the Suppressed Code get: summary: Get a Suppressed Code tags: - Suppressed Code responses: '200': description: OK content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1suppressed-codes/post/responses/201/content/application~1json/schema' operationId: get-campaigns-campaignId-attribution-suppressed-codes-id description: Get a Suppressed Code instance patch: summary: Update a Suppressed Code operationId: patch-v2-campaigns-campaignId-attribution-suppressed-codes-id responses: '200': description: OK content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1suppressed-codes/post/responses/201/content/application~1json/schema' description: Update a Suppressed Code. All request body properties are optional but at least one must be specified for update. tags: - Suppressed Code requestBody: content: application/json: schema: title: Suppressed Code Update Request type: object description: Update a Suppressed Code x-examples: Update suppressed code: voucher_code: NEWITEM publisher_id: 1111l2 start_date: '2020-12-05T15:13:00+00:00' end_date: '2020-12-31T23:59:59+00:00' minProperties: 1 properties: voucher_code: oneOf: - type: string pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 description: An exact match voucher code - allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1suppressed-codes/post/requestBody/content/application~1json/schema/properties/voucher_code/oneOf/1/allOf/0' - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/requestBody/content/application~1json/schema/properties/voucher_code/oneOf/1/allOf/1' - title: Suppressed Code All Values type: object description: Suppresses all voucher codes properties: operator: type: string enum: - ALL required: - operator start_date: type: string format: date-time description: The date from which the voucher code is valid. This is inclusive. end_date: allOf: - description: The date until the voucher code is valid. This is inclusive. - anyOf: - type: string format: date-time - type: 'null' delete: summary: Delete a Suppressed Code responses: '204': description: No Content operationId: delete-campaigns-campaignId-attribution-suppressed-codes-id description: Delete and Suppressed Code tags: - Suppressed Code /v2/campaigns/{campaignId}/attribution/preferred-partners: parameters: - $ref: '#/components/parameters/campaignId' get: summary: List All Preferred Partners responses: '200': description: OK content: application/json: schema: title: Preferred Partners Response type: object properties: data: title: Preferred Partners type: array items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1preferred-partners/post/responses/201/content/application~1json/schema/properties/data' description: A Collection of Preferred Partners hypermedia: type: object description: '' properties: next: type: - string - 'null' description: The URL to call for the next set of preferred partners example: https://api.partnerize.com/v2/campaigns/1101l40123/attribution/preferred-partners?limit=100&offset=100 meta: type: object properties: enabled: type: boolean description: Is Preferred Partners attribution enabled on this campaign? example: true operationId: get-v2-attribution-preferred-partner parameters: - schema: type: integer minimum: 0 maximum: 200 in: query name: limit description: Used to limit the response to a number of results. Defaults to 20 - schema: type: integer minimum: 0 in: query name: offset description: Used to offset the results we're returning - schema: type: string pattern: ^[-a-z0-9_]++$ in: query name: name description: 'Search for partner by name. Alphanumeric with dashes and underscores ' - schema: type: string pattern: ^.*?,.*?$ example: 2020-10-01T00:00:00Z,2020-10-31T00:00:00Z in: query name: dates description: Search for preferred partners within a date range. Comma separated start and end date - schema: type: string example: active,scheduled,expired pattern: ^\w+(,\w+)*$ in: query name: statuses description: A comma separated list of statuses to return results for description: Show a list of all configured preferred partners. May be filtered with several filters. tags: - Preferred Partner post: summary: Create Preferred Partner operationId: post-v2-campaigns-campaignId-attribution-preferred-partners responses: '201': description: Created content: application/json: schema: title: Preferred Partner Response type: object properties: data: title: Preferred Partner type: object description: A Preferred Partner properties: id: type: string description: The Unique ID of this configuration of Preferred Partner example: 10110l2398476 partner: type: object description: The information about the Partner that is preferred properties: id: type: string description: The Partners unique identifier example: 10110l567801 name: type: string description: The Partners name example: Joel status: type: string enum: - invited - rejected - approved - requested description: The status of the partner on the campaign example: approved start_date: type: string format: date-time description: The date the partner is considered preferred from example: '2022-11-01T00:00:00+00:00' end_date: type: string format: date-time description: The date the partner is considered preferred until. This is inclusive. example: '2022-11-30T23:59:59+00:00' status: type: string enum: - scheduled - active - expired description: The status of this Preferred Partner instance example: scheduled created: type: string format: date-time description: The date and time this configuration was created at example: '2022-09-24T14:15:22+00:00' description: Create a Preferred Partner configuration requestBody: content: application/json: schema: title: Preferred Partner Request type: object description: A Preferred Partner properties: partner_id: type: string pattern: ^[a-z0-9]+$ minLength: 1 description: The ID of the Partner to prefer for this date range example: 10110l567801 start_date: type: string format: date-time description: The date the partner is considered preferred from end_date: type: string format: date-time description: The date the partner is considered preferred until. This is inclusive. required: - partner_id - start_date - end_date tags: - Preferred Partner delete: summary: Delete Preferred Partners operationId: bulk-delete-v2-campaigns-campaignId-attribution-preferred-partners responses: '204': description: No Content description: Delete Preferred Partners. This is only possible if the Preferred Partners are scheduled, otherwise an error will occur. requestBody: content: application/json: schema: title: Delete Preferred Partner Request type: object properties: preferred_partner_ids: minItems: 1 items: type: string description: The Unique ID of Preferred Partner to be deleted required: - preferred_partner_ids tags: - Preferred Partner /v2/campaigns/{campaignId}/attribution/preferred-partners/{id}: parameters: - $ref: '#/components/parameters/campaignId' - schema: type: string in: path name: id description: The Preferred Partner ID required: true example: 10110l2398476 delete: summary: Delete a Preferred Partner operationId: delete-v2-campaigns-campaignId-attribution-preferred-partners-id responses: '204': description: No Content description: Delete a Preferred Partner. This is only possible if the Preferred Partner is scheduled, otherwise an error will occur. tags: - Preferred Partner get: summary: Get a Preferred Partner operationId: get-v2-campaigns-campaignId-attribution-preferred-partners-id responses: '200': description: OK content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1preferred-partners/post/responses/201/content/application~1json/schema' description: Get a Preferred Partner by ID tags: - Preferred Partner patch: summary: Update a Preferred Partner operationId: patch-v2-campaigns-campaignId-attribution-preferred-partners-id responses: '200': description: OK content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1preferred-partners/post/responses/201/content/application~1json/schema' description: Update Preferred Partner tags: - Preferred Partner requestBody: content: application/json: schema: title: Preferred Partner Update Request type: object description: A Preferred Partner minProperties: 1 properties: partner_id: type: string description: The ID of the Partner to prefer for this date range example: 10110l567801 start_date: type: string format: date-time description: The date the partner is considered preferred from example: '2022-11-01T00:00:00+00:00' end_date: type: string format: date-time description: The date the partner is considered preferred until. This is inclusive. example: '2022-11-30T23:59:59+00:00' /v2/campaigns/{campaignId}/attribution/exclusive-codes: parameters: - $ref: '#/components/parameters/campaignId' get: summary: List All Exclusive Codes tags: - Exclusive Code responses: '200': description: OK content: application/json: schema: title: Exclusive Code Response type: object properties: data: title: Exclusive Codes type: array description: A Collection of Exclusive Codes items: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/responses/201/content/application~1json/schema/properties/data' count: type: integer description: The total number of results available example: 15 hypermedia: type: object properties: next: type: - string - 'null' description: The URL to call for the next set of preferred partners example: https://api.partnerize.com/v2/campaigns/1101l40123/attribution/exclusive-codes?limit=100&offset=100 meta: type: object properties: enabled: type: boolean description: Is Exclusive Codes attribution enabled on this campaign? example: true operationId: get-v2-attribution-exclusive-codes parameters: - schema: type: integer minimum: 0 maximum: 200 in: query name: limit description: Used to limit the response to a number of results - schema: type: integer minimum: 0 in: query name: offset description: Used to offset the results we're returning - schema: type: string pattern: ^[-a-z0-9_]++$ in: query name: query description: Search for specific codes or partner names - schema: type: string pattern: ^.*?,.*?$ example: 2020-10-01T00:00:00Z,2020-10-31T00:00:00Z in: query name: dates description: Search for codes within a date-time range. Comma separated start and end date-times - schema: type: string example: active,scheduled,expired pattern: ^\w+(,\w+)*$ in: query name: statuses description: A comma separated list of statuses to return results for description: Show a list of all configured exclusive codes. May be filtered with several filters. post: summary: Create an Exclusive Code operationId: post-v2-campaigns-campaignId-attribution-exclusive-codes responses: '201': description: Created content: application/json: schema: title: Exclusive Code Response type: object properties: data: title: Exclusive Code type: object properties: id: type: string description: The unique ID of this Exclusive Code example: 10110l22587 voucher_code: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/requestBody/content/application~1json/schema/properties/voucher_code/oneOf/1/allOf/0' partner: type: object description: The information about the Partner that the exclusive code belongs to properties: id: type: string description: The Partners unique identifier example: 10110l567801 name: type: string description: The Partners name example: Joel status: type: string enum: - invited - rejected - approved - requested description: The status of the partner on the campaign example: approved start_date: type: string format: date-time description: The date the code is considered exclusive from example: '2022-11-01T00:00:00+00:00' end_date: type: - string - 'null' format: date-time description: The date the code is considered exclusive until. This is inclusive. example: '2022-11-30T23:59:59+00:00' is_clickless: type: boolean description: Specifies if the Exclusive Code has Clickless Campaign Based Reallocation behaviour. example: false status: type: string enum: - scheduled - active - expired description: The status of this Exclusive Code instance example: active description: Create an Exclusive Code configuration tags: - Exclusive Code requestBody: content: application/json: schema: title: Exclusive Code Request type: object properties: voucher_code: oneOf: - type: string pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 description: An exact match voucher code - allOf: - title: Exclusive Code Fuzzy Value type: object description: A fuzzy matched value properties: value: type: string pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 example: SUMMER10 operator: type: string enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - type: object required: - value - operator partner_id: type: string pattern: ^[a-z0-9]+$ minLength: 1 start_date: type: string format: date-time end_date: type: - string - 'null' format: date-time is_clickless: type: boolean description: Specifies if the Exclusive Code has Clickless Campaign Based Reallocation behaviour. This setting only applies to Master Campaign setups. default: false required: - voucher_code - partner_id - start_date delete: summary: Delete Exclusive Codes operationId: bulk-delete-v2-campaigns-campaignId-attribution-exclusive-codes responses: '204': description: No Content description: Delete Exclusive Codes. This is only possible if the Exclusive Codes are scheduled, otherwise an error will occur. requestBody: content: application/json: schema: title: Delete Exclusive Code Request type: object properties: exclusive_code_ids: minItems: 1 items: type: string description: The Unique ID of Exclusive Code to be deleted required: - exclusive_code_ids tags: - Exclusive Code /v2/campaigns/{campaignId}/attribution/exclusive-codes/{id}: parameters: - $ref: '#/components/parameters/campaignId' - schema: type: string example: 1001l1 name: id in: path required: true description: The ID of the Exclusive Code get: summary: Get an Exclusive Code tags: - Exclusive Code responses: '200': description: OK content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/responses/201/content/application~1json/schema' operationId: get-campaigns-campaignId-attribution-exclusive-codes-id description: Get an Exclusive Code instance patch: summary: Update an Exclusive Code operationId: patch-v2-campaigns-campaignId-attribution-exclusive-codes-id responses: '200': description: OK content: application/json: schema: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/responses/201/content/application~1json/schema' description: Update an Exclusive Code. All request body properties are optional but at least one must be specified for update. tags: - Exclusive Code requestBody: content: application/json: schema: title: Exclusive Code Update Request type: object description: Update an exclusive code minProperties: 1 properties: voucher_code: oneOf: - type: string pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 description: An exact match voucher code - allOf: - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/requestBody/content/application~1json/schema/properties/voucher_code/oneOf/1/allOf/0' - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1exclusive-codes/post/requestBody/content/application~1json/schema/properties/voucher_code/oneOf/1/allOf/1' partner_id: type: string description: The ID of the Partner who will receive commission when this voucher code is used. start_date: type: string format: date-time description: The date from which the voucher code is valid. This is inclusive. end_date: description: The date until the voucher code is valid. This is inclusive. type: - string - 'null' format: date-time is_clickless: type: boolean description: Specifies if the Exclusive Code has Clickless Campaign Based Reallocation behaviour. This setting only applies to Master Campaign setups. default: false delete: summary: Delete an Exclusive Code responses: '204': description: No Content operationId: delete-campaigns-campaignId-attribution-exclusive-codes-id description: Delete an Exclusive Code tags: - Exclusive Code /v2/campaigns/{campaignId}/attribution/in-cart: parameters: - $ref: '#/components/parameters/campaignId' get: summary: List In-Cart Settings responses: '200': description: OK content: application/json: schema: title: In Cart Response type: object properties: data: title: In Cart type: object properties: threshold: type: integer description: Duration in seconds minimum: 1 maximum: 3540 example: 60 excluded_partners: type: array description: An array of partners excluded from in cart attribution. items: title: Partner type: object properties: id: type: string example: 10110l1 name: type: string example: Joel example: - id: 10110l123 name: Joel - id: 10110l456 name: Jenny reject_solo_click: title: Reject solo click type: object properties: enabled: type: boolean description: Whether reject solo click in cart is enabled default: false example: true meta: type: object properties: enabled: type: boolean description: Is In-Cart attribution enabled on this campaign? operationId: get-v2-attribution-in-cart description: Get the In-Cart settings for the given Campaign tags: - In-Cart patch: summary: Update In-Cart Settings operationId: post-v2-attribution-in-cart responses: '200': description: OK content: application/json: schema: title: In Cart Response type: object properties: data: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1in-cart/get/responses/200/content/application~1json/schema/properties/data' requestBody: content: application/json: schema: title: In Cart request type: object properties: threshold: type: integer description: Duration in seconds minimum: 1 maximum: 3540 example: 60 excluded_partners: type: array description: An array of partner IDs that are not affected by in cart attribution items: type: string maxItems: 200 example: - 10110l123 - 10110l456 reject_solo_click: title: Reject solo click type: object properties: enabled: type: boolean description: Whether reject solo click in cart is enabled default: false example: true required: - enabled required: - threshold - excluded_partners description: Update the In-Cart settings for the Given Campaign tags: - In-Cart /v2/campaigns/{campaignId}/attribution/split: parameters: - $ref: '#/components/parameters/campaignId' get: summary: List Split Settings tags: - Split responses: '200': description: OK content: application/json: schema: title: Split Response type: object description: '' properties: data: title: Split type: object properties: initiator: type: number minimum: 0 description: What portion of the conversion does the initiator receive maximum: 100 example: 50 contributor_missing: type: string description: 'If no contributors are found, how should the remaining amount be divided? ' enum: - converter - initiator - split example: split converter: type: number minimum: 0 description: What portion of the conversion does the converter receive maximum: 100 example: 50 excluded_partners: type: array description: An array of partner IDs that are not affected by split attribution. items: title: Partner type: object properties: id: type: string example: 10110l1 name: type: string example: Joel example: - id: 10110l123 name: Joel - id: 10110l456 name: Jenny excluded_groups: type: array description: An array of group IDs that are not affected by split attribution. items: title: Group type: object properties: id: type: string example: 10110l3 name: type: string example: Cashback example: - id: 10110l789 name: Cashback - id: 10110l246 name: Voucher meta: type: object properties: enabled: type: boolean description: Is Split attribution enabled on this campaign? operationId: get-v2-campaigns-campaignId-attribution-split description: Get the Split attribution settings for the given Campaign patch: summary: Update Split Settings tags: - Split responses: '200': description: OK content: application/json: schema: title: Split Response type: object description: '' properties: data: $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1attribution~1split/get/responses/200/content/application~1json/schema/properties/data' operationId: patch-v2-campaigns-campaignId-attribution-split requestBody: content: application/json: schema: title: Split Request type: object minProperties: 1 properties: initiator: type: number minimum: 0 description: What portion of the conversion does the initiator receive maximum: 100 example: 50 contributor_missing: type: string description: 'If no contributors are found, how should the remaining amount be divided? ' enum: - converter - initiator - split example: split converter: type: number minimum: 0 description: What portion of the conversion does the converter receive maximum: 100 example: 50 excluded_partners: type: array description: An array of partner IDs that are not affected by split attribution. items: type: string example: - 10110l123 - 10110l456 excluded_groups: type: array description: An array of group IDs that are not affected by split attribution. items: type: string example: - 10110l789 - 10110l246 description: Update the Split settings for the given Campaign /v2/networks/{network_id}/publishers: parameters: - name: network_id description: The publishers' network id in: path required: true schema: type: string get: tags: - Publishers summary: Get publishers list parameters: - $ref: '#/components/schemas/Publishers_V2_Filters/account_created' - $ref: '#/components/schemas/Publishers_V2_Filters/campaign_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/campaign_statuses' - $ref: '#/components/schemas/Publishers_V2_Filters/commission_group_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/company_name' - $ref: '#/components/schemas/Publishers_V2_Filters/fields' - $ref: '#/components/schemas/Publishers_V2_Filters/ids' - $ref: '#/components/schemas/Publishers_V2_Filters/include_discovery' - $ref: '#/components/schemas/Publishers_V2_Filters/website_verified' - $ref: '#/components/schemas/Publishers_V2_Filters/limit' - $ref: '#/components/schemas/Publishers_V2_Filters/locales' - $ref: '#/components/schemas/Publishers_V2_Filters/network_statuses' - $ref: '#/components/schemas/Publishers_V2_Filters/offset' - $ref: '#/components/schemas/Publishers_V2_Filters/operating_countries' - $ref: '#/components/schemas/Publishers_V2_Filters/partner_collection_id' - $ref: '#/components/schemas/Publishers_V2_Filters/promotional_countries' - $ref: '#/components/schemas/Publishers_V2_Filters/promotional_method_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_email' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_name' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_tag_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_website' - $ref: '#/components/schemas/Publishers_V2_Filters/reporting_identifier' - $ref: '#/components/schemas/Publishers_V2_Filters/search' - $ref: '#/components/schemas/Publishers_V2_Filters/sort' - $ref: '#/components/schemas/Publishers_V2_Filters/vertical_ids' - in: query name: recipient_status description: Accepts a communication ID. Adds a flag into the response whether publishers are on that communication's recipient list schema: type: string example: 111111l1 responses: '200': description: The list of filtered publishers content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: count: type: integer example: 56 limit: type: integer example: 100 offset: type: integer publishers: type: array items: allOf: - $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: recipient_status: type: boolean description: Only included if valid recipient_status query argument is supplied '400': description: Invalid filter property content: application/json: schema: title: Error Response type: object properties: error: title: Errors type: object required: - errors - message - code description: Error Definition properties: errors: type: array description: Occurred Errors minItems: 1 items: title: Error type: object description: Error properties: type: type: string description: Error Type code: type: string description: Error Code message: type: string description: Error Message required: - type - code - message message: type: string description: Status Message code: type: integer description: Status Code required: - error '403': description: Unauthorised request content: application/json: schema: example: error: errors: - type: error code: unauthorised message: You do not have 'read' permission on publisher with id '1' code: 403 message: Forbidden type: object properties: error: type: object properties: errors: items: type: object properties: type: type: string code: type: string message: type: string code: type: integer message: type: string operationId: get-publishers description: Get Publishers for Network /v2/networks/{network_id}/publishers.csv: parameters: - in: header name: Accept schema: type: string enum: - charset=UTF-16 - name: network_id description: The publishers' network id in: path required: true schema: type: string post: operationId: export-publishers description: Export publishers for a network requestBody: required: false content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object properties: delimiter: type: string enum: - ',' - '|' - "\t" default: ',' excluded_publisher_id: type: array items: type: string limit: type: integer default: 50000 maximum: 50000 description: 'Note: these default and maximum values only apply when you are not emailing the result csv. When emailing the csv, the default is `null` and there is no maximum limit' offset: type: integer default: null nullable: true filter: type: array items: anyOf: - type: object additionalProperties: false required: - property - value properties: property: enum: - campaign_ids - campaign_statuses - commission_group_ids - ids - locales - network_statuses - operating_countries - promotional_country - promotional_method_ids - vertical_id value: type: - string - array - type: object additionalProperties: false required: - property - value properties: property: enum: - account_created - company_name - include_discovery - search - sort - website_verified value: type: string email_result: oneOf: - type: string minLength: 1 description: An email address of the email's recipient format: email - type: boolean description: '''true'' sends email to the authenticated user. ''false'' does not send an email and returns the csv contents in the request response instead.' fields: type: array items: type: string enum: - account_created - campaigns - company_name - contact_email - contact_name - id - instant_messaging - locale - metadata - name - network_id - network_notes - operating_country - phone_number - promotional_method - reporting_identifier - signup_ip - vertical - websites - commission_groups - website_info tags: - Publishers summary: Export publishers produces: - text/csv responses: '201': description: The list of filtered publishers content: text/csv: schema: type: string example: 'created_date,signup_ip,publisher_id,account_name,reporting_identifier,available_campaigns,approved_campaigns,invited_campaigns,requested_campaigns,rejected_campaigns,contact_name,contact_email,company_name,phone_area,phone,im_provider,im_username,operating_country,contact_locale,vertical_name,promotional_method_name,websites_website_url,website_verification_status,network_metadata_1,network_metadata_2,network_metadata_3 "2019-10-30 11:08:41",80.80.80.80,111111l1,my_account,acc_reporting_id,"Campaign Avail","Campaign App A,Campaign App B","Campaign Inv","Campaign Req","Campaign Rej","Joe Bloggs",info@partnerize.com,"Partnerize",0191,12345678,Skype,jbskype,GB,en,Retail,PPC,http://www.partnerize.com,"https://partnerize.com :: verified | https://partner.com :: unverified","Network metadata 1","Network metadata 2","Network metadata 3" ' '202': description: When the exported report has been accepted and will be emailed to the user '400': description: Invalid filter property content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' '403': description: Unauthorised request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/403/content/application~1json/schema' /v2/networks/{network_id}/publishers/{publisher_id}: parameters: - name: network_id description: The publishers' network id in: path required: true schema: type: string - name: publisher_id description: The publisher id in: path required: true schema: type: string get: tags: - Publishers summary: Get publisher details responses: '200': description: Details about an individual Publisher on the network. content: application/json: schema: allOf: - type: object title: Publisher properties: id: type: string example: 10000l1 name: type: string example: Name company_name: type: string example: Company Name company_logo: type: string example: http://some.url/image.jpg contact_email: type: string example: contact@partnerize.com locale: type: string example: en operating_country: type: object properties: id: type: string iso: type: string name: type: string vertical: title: Vertical $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/0/properties/commission_groups/items' promotional_method: title: Promotional method $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/0/properties/commission_groups/items' websites: type: array items: type: object title: Website properties: id: type: string website_url: type: string example: http://www.partnerize.com description: type: string example: A blog about partner marketing campaigns: type: array items: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/campaigns/items/allOf/0' commission_groups: type: array items: type: object properties: id: type: string name: type: string partner_collection_ids: type: array items: type: string signup_ip: type: string example: 127.0.0.1 network_notes: type: string nullable: true network_id: type: string example: 111111l1 - type: object properties: campaigns: type: array items: allOf: - type: object title: Campaign properties: id: type: string name: type: string status: $ref: '#/components/schemas/Publishers_V2_Filters/campaign_statuses/schema/oneOf/0' camref: type: - 'null' - string tracking_link: type: - 'null' - string status_changed_at: description: The datetime when the status of the campaign-publisher relationship was last updated nullable: true type: datetime - type: object properties: destination_url: type: string advertiser_id: type: string account_created: type: string format: - date-time example: '2020-09-01T14:20:03+00:01' contact_name: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/description' description: oneOf: - type: string - type: 'null' active: oneOf: - type: boolean - type: 'null' address: type: object properties: line1: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/description' line2: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/description' line3: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/description' line4: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/description' postcode: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/description' country: allOf: - $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1%7Bpublisher_id%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/description' - description: 2 letter ISO country code, see https://api.partnerize.com/reference/country network_notes: type: string nullable: true '403': description: Unauthorised request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/403/content/application~1json/schema' '404': description: Publisher not found content: application/json: schema: type: object properties: error: type: object example: error: errors: - type: error code: entity_not_found message: publisher not found for id '{id}' code: 404 message: Not Found operationId: get-publisher-details description: Get Publishers Details for Network /v2/networks/{network_id}/publishers/ids: parameters: - name: network_id description: The publishers' network id in: path required: true schema: type: string get: tags: - Publishers summary: Get publishers ids list parameters: - $ref: '#/components/schemas/Publishers_V2_Filters/account_created' - $ref: '#/components/schemas/Publishers_V2_Filters/campaign_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/campaign_statuses' - $ref: '#/components/schemas/Publishers_V2_Filters/commission_group_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/company_name' - $ref: '#/components/schemas/Publishers_V2_Filters/ids' - $ref: '#/components/schemas/Publishers_V2_Filters/include_discovery' - $ref: '#/components/schemas/Publishers_V2_Filters/website_verified' - $ref: '#/components/schemas/Publishers_V2_Filters/limit' - $ref: '#/components/schemas/Publishers_V2_Filters/locales' - $ref: '#/components/schemas/Publishers_V2_Filters/network_statuses' - $ref: '#/components/schemas/Publishers_V2_Filters/offset' - $ref: '#/components/schemas/Publishers_V2_Filters/operating_countries' - $ref: '#/components/schemas/Publishers_V2_Filters/promotional_countries' - $ref: '#/components/schemas/Publishers_V2_Filters/promotional_method_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_email' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_name' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_tag_ids' - $ref: '#/components/schemas/Publishers_V2_Filters/publisher_website' - $ref: '#/components/schemas/Publishers_V2_Filters/reporting_identifier' - $ref: '#/components/schemas/Publishers_V2_Filters/search' - $ref: '#/components/schemas/Publishers_V2_Filters/sort' - $ref: '#/components/schemas/Publishers_V2_Filters/vertical_ids' responses: '200': description: The list of filtered publishers ids content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: count: type: integer example: 1 publisher_ids: type: array items: type: string '400': description: Invalid filter property content: application/json: schema: type: object properties: error: type: object properties: errors: items: type: object properties: type: type: string code: type: string message: type: string code: type: integer message: type: string '403': description: Unauthorised request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/403/content/application~1json/schema' operationId: get-publishers-ids description: Get a list of publisher ids /v2/networks/{networkId}/campaign-requests-invites: parameters: - name: networkId in: path description: ID of the brand network examples: - 1l1007802 required: true schema: type: string - name: vertical_id in: query description: ID of the vertical being filtered by examples: - '10' required: false schema: type: string - name: promo_method_id in: query description: ID of the promo method being filtered by examples: - '17' required: false schema: type: string - name: operating_country in: query description: The operating country code being filtered by examples: - '10' required: false schema: type: string - name: promotional_country in: query description: The promotional country ISO code examples: - GB required: false schema: type: string - name: campaign_id in: query description: ID of the vertical being filtered by examples: - '10' required: false schema: type: string - name: status in: query description: The status of the interaction examples: - invited - requested required: false schema: type: string - name: search in: query description: Query string being search for which gets checked against the applicable fields. examples: - campaign 123 required: false schema: type: string get: operationId: partner-requests-invites tags: - Campaign Requests and Invites summary: List Partner Campaign Requests and Invites description: Lists partners with campaign requests or invites responses: '200': description: OK content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Partner Response properties: partners: type: array items: $schema: http://json-schema.org/draft-04/schema title: Partner type: object allOf: - $ref: '#/paths/~1v2~1networks~1%7BnetworkId%7D~1campaign-requests-invites~1partners~1%7BpublisherId%7D/get/responses/200/content/application~1json/schema/properties/partner/allOf/0' - properties: request_count: type: integer title: Campaign request count invite_count: type: integer title: Campaign Invitations hypermedia: $schema: http://json-schema.org/draft-04/schema title: Currency type: object properties: pagination: type: object properties: total_page_count: type: number total_item_count: type: number first_page: type: string last_page: type: string next_page: type: string previous_page: anyOf: - type: 'null' - type: string /v2/networks/{networkId}/campaign-requests-invites/filters: parameters: - name: networkId in: path description: ID of the brand network examples: - 1l1007802 required: true schema: type: string get: operationId: partner-requests-invites-filters tags: - Campaign Requests and Invites summary: List Campaign Requests and Invites Filters. description: Lists filters which can be used in conjuction with the List Campaign Requests and Invites contains the values required for the campaign interaction page filters. responses: '200': description: OK content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Filters Response description: Multiple values are comma delimited. properties: filters: $schema: http://json-schema.org/draft-04/schema title: Filter type: object properties: promo_methods: type: array title: Promo methods description: Any applicable promo method/partner type. items: properties: name: type: string example: Cashback value: type: string example: '73' verticals: type: array title: Verticals description: Any applicable vertical items: properties: name: type: string example: Automotive value: type: string example: '179' campaigns: type: array title: Campaigns description: The campaigns the current logged in user has access to on the included network items: properties: name: type: string example: Adidas value: type: string example: 111111l32 operating_countries: type: array title: Operating countries description: List of available operating countries to filter by. items: properties: name: type: string example: Afghanistan value: type: string example: AF statuses: description: The different status filter options available. type: array title: Status' items: type: string example: - invited - requested custom_promo_methods: type: array title: Custom promo methods description: Network specific promo method/partner type. items: properties: name: type: string example: Cashback value: type: string example: '73' custom_verticals: type: array title: Custom Verticals description: Network specific verticals items: properties: name: type: string example: Automotive value: type: string example: '179' /v2/networks/{networkId}/campaign-requests-invites/partners/{publisherId}: parameters: - name: networkId in: path description: ID of the brand network examples: - 1l1007802 required: true schema: type: string - name: publisherId in: path description: The ID of the partner examples: - 1lPUBA001,1lPUBB002 required: true schema: type: string get: operationId: partner-requests-invites-detail tags: - Campaign Requests and Invites summary: Retrieve Partner Campaign Invites and Requests Details. description: Retrieve details for campaign invites and requests of a particular partner. responses: '200': description: OK content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Partner Response properties: partner: $schema: http://json-schema.org/draft-04/schema title: Partner type: object allOf: - $schema: http://json-schema.org/draft-04/schema title: Partner type: object properties: id: type: string description: ID of the partner example: 111111l300761 name: type: string example: Partner UK reporting_identifier: type: string example: wedo.com active: type: boolean title: Partner Active Status example: false company_name: type: string example: Partner UK company_logo: oneOf: - type: string - type: 'null' example: http://some.url/image.png contact_name: type: string example: John Smith contact_email: type: string example: john@partner.uk description: type: string example: Partner UK account_created: type: string format: - date - time example: '2020-09-01 14:20:03' phone_number: type: string example: '+440201234123' operating_country: title: Operating country $schema: http://json-schema.org/draft-04/schema type: object properties: iso: type: string enum: - GB example: GB name: type: string enum: - United Kingdom example: United Kingdom vertical: $schema: http://json-schema.org/draft-04/schema title: Vertical type: object properties: id: type: string example: '1' name: type: string example: Retail promotional_method: $schema: http://json-schema.org/draft-04/schema title: Promotional method type: object properties: id: type: integer example: 1 name: type: string example: PPC promotional_countries: type: array items: type: object properties: iso: type: string name: type: string websites: type: array items: type: object properties: id: type: string example: 111111l1 website_url: type: string example: http://url.uk description: type: string example: Partner UK website - properties: address: title: Postal Address $schema: http://json-schema.org/draft-04/schema type: object properties: line1: anyOf: - type: 'null' - type: string line2: anyOf: - type: 'null' - type: string line3: anyOf: - type: 'null' - type: string line4: anyOf: - type: 'null' - type: string postcode: anyOf: - type: 'null' - type: string country: anyOf: - type: 'null' - type: string requests: type: array title: Campaign Requests items: properties: id: type: string example: 111111l300883 campaign: $ref: '#/paths/~1v2~1networks~1%7BnetworkId%7D~1campaign-requests-invites~1partners~1%7BpublisherId%7D/get/responses/200/content/application~1json/schema/properties/partner/allOf/1/properties/invites/items/properties/campaign' invites: type: array title: Campaign Invitations items: properties: id: type: string example: 111111l300878 campaign: $schema: http://json-schema.org/draft-04/schema title: Campaign type: object properties: id: type: string default_destination: anyOf: - type: 'null' - type: string title: type: string currency: $schema: http://json-schema.org/draft-04/schema title: Currency type: object properties: iso: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RMB - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW example: GBP name: type: string enum: - United Arab Emirates dirham - Azerbaijani manat - Mexican Unidad de Inversion - Malaysian ringgit - Mozambican metical - Namibian dollar - Nigerian naira - Nicaraguan cordoba - Norwegian krone - Nepalese rupee - New Zealand dollar - Omani rial - Bosnia and Herzegovina convertible mark - Panamanian balboa - Peruvian nuevo sol - Papua New Guinean kina - Philippine peso - Pakistani rupee - Polish zloty - Paraguayan guarani - Qatari riyal - Romanian new leu - Serbian dinar - Barbados dollar - Russian rouble - Rwandan franc - Saudi riyal - Solomon Islands dollar - Seychelles rupee - Sudanese pound - Swedish krona - Singapore dollar - Saint Helena pound - Sierra Leonean leone - Bangladeshi taka - Somali shilling - Surinamese dollar - South Sudanese pound - Sao Tome and Principe dobra - Syrian pound - Swazi lilangeni - Thai baht - Tajikistani somoni - Turkmenistani manat - Tunisian dinar - Bulgarian lev - Tongan pa'anga - Turkish lira - Trinidad and Tobago dollar - New Taiwan dollar - Tanzanian shilling - Ukrainian hryvnia - Ugandan shilling - United States dollar - Uruguayan peso - Uzbekistan som - Bahraini dinar - Venezuelan example: Pound sterling symbol: type: string enum: - AED - ман - MXV - RM - MT - ₦ - C$ - KM - B/. - S/. - PGK - zł - Gs - lei - Дин. - руб - RWF - SDG - SLL - BDT - S - SSP - STD - SZL - ฿ - TJS - TMT - TND - TOP - TRY - TT$ - NT$ - TZS - ₴ - UGX - $U - BHD - Bs - ₫ - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - BIF - XBD - XDR - XFU - XOF - XPD - XPF - XPT - R - ZMW - $b - ؋ - R$ - BTN - P - p. - BZ$ - CDF - CHE - CHF - Lek - CHW - CLF - COU - ₡ - CUC - ₱ - CVE - AMD - Kč - DJF - RD$ - DZD - ERN - ETB - € - GEL - GHS - GMD - GNF - Q - AOA - L - kn - HTG - Ft - Rp - ₪ - INR - IQD - ﷼ - kr - J$ - JOD - ¥ - KES - ៛ - KMF - KWD - лв - ₭ - £ - $ - LSL - Lt - Ls - LYD - ƒ - MAD - MDL - ден - MMK - ₮ - MOP - ₨ - MVR - MWK example: £ advertiser_id: type: string /v2/networks/{networkId}/campaign-requests/accept: parameters: - name: networkId in: path description: ID of the network examples: - 1l1007802 required: true schema: type: string post: summary: Accept Campaign Requests description: 'This endpont is now `Obsolete`. Use [Approve and Invite Partners to Campaigns](#tag/Campaign-Requests-and-Invites/operation/post-v2-networks-network_id-invite-network-partners) instead

An Advertiser may accept requests from Partners to join campaigns within their Network. This bulk endpoint allows a user to reject multiple requests in one call. The payload contains one or more campaign ID and partner ID pairs that uniquely identify each campaign request to accept. ' operationId: accept-campaign-requests tags: - Campaign Requests and Invites requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object required: - campaign_requests properties: campaign_requests: type: array items: $schema: http://json-schema.org/draft-04/schema type: object required: - campaign_id - publisher_id properties: campaign_id: type: string examples: - 726fl66778123 publisher_id: type: string examples: - 6aedl83886767 additionalProperties: false responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object title: Accept Campaign-Request Response required: - success_count - failure_count properties: success_count: type: integer examples: - 1 failure_count: type: integer examples: - 0 /v2/networks/{networkId}/campaign-requests/decline: parameters: - name: networkId in: path description: ID of the network examples: - 1l1007802 required: true schema: type: string post: summary: Decline Campaign Requests description: 'An Advertiser may decline requests from Partners to join campaigns within their Network. This bulk endpoint allows a user to decline multiple requests in one call. The payload contains one or more campaign ID and partner ID pairs that uniquely identify each campaign request to decline. Each partner and campaign pair must include a decline "reason". Use null if no reason is provided. ' operationId: decline-campaign-requests tags: - Campaign Requests and Invites requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object required: - campaign_requests properties: campaign_requests: type: array items: type: object required: - campaign_id - publisher_id - reason properties: campaign_id: type: string examples: - 726fl66778123 publisher_id: type: string examples: - 6aedl83886767 reason: type: string additionalProperties: false responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object title: Decline Campaign-Request Response required: - success_count - failure_count properties: success_count: type: integer examples: - 1 failure_count: type: integer examples: - 0 /v2/networks/{network_id}/invite/network-partners: post: summary: Approve and Invite Partners to Campaigns tags: - Campaign Requests and Invites parameters: - in: header name: X-Prefer schema: type: string enum: - return-synch - return-asynch required: false - in: path name: network_id schema: type: string required: true responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object required: - success_count - failure_count properties: success_count: type: integer examples: - 1 failure_count: type: integer examples: - 0 '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1ids/get/responses/400/content/application~1json/schema' operationId: post-v2-networks-network_id-invite-network-partners description: An Advertiser can invite one or more Network Partners to one or more Campaigns. The user must have manage participation permission over each campaign in the payload. The payload will be validated and invitations will be created only if all fields are valid. If a partner has already been invited or is approved on the campaign, the campaign will be skipped. If the partner has an existing request to join the campaign, the request will be resolved and the partner will be immediately approved on the campaign. Notifications will be sent according to each partner's preferences. requestBody: content: application/json: schema: oneOf: - properties: partner_collection_id: type: string campaign_id: type: array items: type: string - properties: publisher_id: type: array items: type: string campaign_id: type: array items: type: string - properties: filter: type: array items: {} campaign_id: type: array items: type: string excluded_publisher_id: type: array items: type: string type: object examples: Collection based request: value: partner_collection_id: 11111l1 campaign_id: - 11111l21 - 11111l22 Selection based request: value: publisher_id: - 11111l1 - 11111l2 campaign_id: - 11111l21 - 11111l22 Filter based request: value: filter: - property: search value: cash - property: vertical_id value: - '6' - property: promo_method_id value: - '70' - property: operating_country value: - US - property: promotional_country value: - US - property: campaign_id value: - 11111l90 - property: campaign_status value: - approved - requested campaign_id: - 11111l21 - 11111l22 excluded_publisher_id: - 11111l102 description: 'Selection based requests simply require a list of Publisher and Campaign IDs. The server will create invitations from the combination of the two lists. Collection based requests require a partner collection creating first. Alternatively when inviting many Publishers at once, instead of listing every PublisherID, a filter based request allows the user to specify filters with which to match Publishers. You can exclude specific Publishers by listing their IDs using the `excluded_publisher_id` property.' get: summary: Display pending outcomes - invitations and approvals operationId: inviteDryRun description: List all potential invitations and approvals for given set of campaigns tags: - Campaign Requests and Invites parameters: - name: network_id in: path description: The network id required: true - in: query name: partner_collection_id required: true schema: type: string - in: query name: campaign_ids required: true schema: type: array items: type: string - in: query name: search required: false schema: type: string - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number responses: '200': description: Success content: application/json: schema: $schema: http://json-schema.org/draft-04/schema# type: object properties: partners: type: array items: type: object properties: id: type: string examples: - 1101l78103 name: type: string examples: - Greatest Partner company_name: type: string examples: - Greatest Partner Inc. campaigns: type: array items: type: object properties: id: type: string examples: - 1101l78105 name: type: string examples: - 'Campaign #1' status: type: string examples: - APPROVED - INVITED approval_date: type: string examples: - '2022-01-01 00:00:00' - 'null' websites: type: array items: type: object properties: id: type: string examples: - 1101l78105 website_url: type: string examples: - https://partnerize.com description: type: string examples: - Description count: type: integer examples: - 3 limit: type: integer examples: - 10 offset: type: integer examples: - 0 '400': description: Bad Request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1ids/get/responses/400/content/application~1json/schema' /v2/networks/{network_id}/invite/network-partners.csv: post: summary: Export pending outcomes - invitations and approvals into CSV operationId: exportDryRun description: CSV all potential invitations and approvals for given set of campaigns tags: - Campaign Requests and Invites parameters: - name: network_id in: path description: The network id required: true - in: query name: partner_collection_id required: true schema: type: string - in: query name: campaign_ids required: true schema: type: array items: type: string produces: - text/csv responses: '201': description: The list of filtered publishers content: text/csv: schema: type: string example: 'partner_id,partner_name,company_name,partner_website,campaign_id,campaign_name,campaign_status,campaign_approval_date 111111l1,voucherbox_demo,16plus_voucherbox,https://www.bbc.co.uk,111111l1,"Cards & Loans",approved,2019-10-30T11:08:41+00:00 ' /v2/networks/{network_id}/reject/network-partners: parameters: - in: header name: X-Prefer schema: type: string enum: - return-synch - return-asynch required: false - in: path name: network_id schema: type: string required: true post: summary: Reject partners from a campaign tags: - Campaign Requests and Invites responses: '200': description: Success content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1invite~1network-partners/post/responses/200/content/application~1json/schema' '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers~1ids/get/responses/400/content/application~1json/schema' operationId: post-v2-networks-network_id-reject-partners description: An Advertiser can reject one or more Partners from a campaign. requestBody: content: application/json: schema: oneOf: - properties: partner_collection_id: type: string campaign_id: type: array - properties: publisher_id: type: array items: type: string campaign_id: type: array - properties: filter: type: array items: {} excluded_publisher_id: type: array items: type: string campaign_id: type: array type: object examples: Selection based request: value: publisher_id: - 11111l1 - 11111l2 campaign_id: - 11111l1 - 11111l2 Filter based request: value: filter: - property: search value: cash - property: vertical_id value: - '6' - property: promo_method_id value: - '70' - property: operating_country value: - US - property: promotional_country value: - US - property: campaign_id value: - 11111l90 - property: campaign_status value: - approved - requested - requested excluded_publisher_id: - 11111l102 campaign_id: - 11111l1 - 11111l2 description: 'Selection based requests simply require a list of Publisher IDs. The server will approve publishers in the list. Collection based requests require a partner collection creating first. Alternatively when blocking many Publishers at once, instead of listing every PublisherID, a filter based request allows the user to specify filters with which to match Publishers. You can exclude specific Publishers by listing their IDs using the `excluded_publisher_id` property.' /v2/networks/{networkId}/marketplace/settings/advertisers: get: summary: List discovery settings for brands description: 'Retrieve a list of brands and their campaign discovery settings ' operationId: getMarketplaceBrands tags: - Discovery Settings parameters: - name: show_test_mode description: 'Decide if campaigns should be returned if they are in test mode (default value: false)' in: path required: false schema: type: boolean - name: show_hidden description: 'Decide if campaigns should be returned if they are hidden (default value: false)' in: path required: false schema: type: boolean responses: '200': description: Brand List content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Advertiser Marketplace settings List Response properties: advertisers: type: array items: $schema: http://json-schema.org/draft-04/schema type: object title: Advertiser properties: id: type: string description: ID of the brand name: type: string description: Name of the brand participating: type: boolean description: Whether the brand is participating in marketplace or not campaigns: type: array items: $schema: http://json-schema.org/draft-04/schema type: object title: Campaign properties: id: type: string description: ID of the campaign name: type: string description: Name of the campaign shown: type: boolean description: Whether the campaign is shown within in marketplace or not testMode: type: boolean description: Whether the campaign is in test mode hidden: type: boolean description: Whether the campaign is hidden status: type: string enum: - Active - Retired - N/A description: The status of the campaign put: summary: Update Brand Marketplace settings description: 'Update the discovery settings of the brand ' operationId: updateMarketplaceBrands tags: - Discovery Settings requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object title: Advertiser Marketplace settings List Response properties: advertisers: type: array items: $schema: http://json-schema.org/draft-04/schema type: object title: Advertiser properties: id: type: string description: ID of the brand name: type: string description: Name of the brand participating: type: boolean description: Whether the brand is participating in marketplace or not campaigns: type: array items: $schema: http://json-schema.org/draft-04/schema type: object title: Campaign properties: id: type: string description: ID of the campaign name: type: string description: Name of the campaign shown: type: boolean description: Whether the campaign is shown within in marketplace or not required: - advertisers responses: '200': description: Brand List content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7BnetworkId%7D~1marketplace~1settings~1advertisers/put/requestBody/content/application~1json/schema' /v2/networks/{network_id}/partner-collections: parameters: - name: network_id description: The publishers' network id in: path required: true schema: type: string post: tags: - Publishers summary: Create publisher collection requestBody: required: true content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object allOf: - $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1partner-collections~1%7Bcollection-id%7D~1partners/post/requestBody/content/application~1json/schema' - type: object properties: ttl: type: integer responses: '201': description: Created content: application/json: schema: $schema: http://json-schema.org/draft-04/schema title: Partner type: object properties: collection: type: object properties: id: type: string example: 111111l86 network_id: type: string example: 111111l1 created_by: type: string example: 111111l1 created: type: object properties: date: type: string example: '2023-04-07 11:12:25.000000' timezone_type: type: number example: 3 timezone: type: string example: UTC updated: type: object properties: date: type: string example: '2023-04-07 11:12:25.000000' timezone_type: type: number example: 3 timezone: type: string example: UTC delete: oneOf: - type: object properties: date: type: string example: '2023-04-07 11:12:25.000000' timezone_type: type: number example: 3 timezone: type: string example: UTC - type: 'null' partners_count: type: number example: 12 '400': description: Bad Request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' operationId: post-publisher-collection description: Create publisher collection /v2/networks/{network_id}/partner-collections/{collection-id}: parameters: - name: network_id description: The publishers' network id in: path required: true schema: type: string - name: collection-id description: The collection id in: path required: true schema: type: string delete: tags: - Publishers summary: Delete publisher collection responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' /v2/networks/{network_id}/partner-collections/{collection-id}/partners: parameters: - name: network_id description: The publishers' network id in: path required: true schema: type: string - name: collection-id description: The collection id in: path required: true schema: type: string post: operationId: post-publisher-collection-partners summary: Add publishers to a collection tags: - Publishers requestBody: required: true content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object oneOf: - type: object properties: partner_ids: type: array items: type: string - type: object properties: filter: type: array description: Filters items: - type: object properties: property: type: string enum: - commission_group_ids - campaign_ids - campaign_statuses - company_name - include_discovery - locales - network_statuses - operating_countries - promotional_method_ids - promotional_countries - search - vertical_ids value: oneOf: - type: string - type: array items: type: string excluded_publisher_ids: type: array items: type: string responses: '201': description: Created content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1partner-collections/post/responses/201/content/application~1json/schema' '400': description: Bad Request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' delete: operationId: delete-publisher-collection-partners summary: Remove publishers from a collection tags: - Publishers requestBody: required: true content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1partner-collections~1%7Bcollection-id%7D~1partners/post/requestBody/content/application~1json/schema' responses: '200': description: Partners removed content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1partner-collections/post/responses/201/content/application~1json/schema' '400': description: Bad Request content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' /v2/communications: get: tags: - Communications summary: List communications description: Lists all communications which the user has access to. Filtering by status is available via a query parameter. parameters: - in: query name: status schema: type: string enum: - draft - sent - scheduled description: A comma separated list of statuses responses: '200': description: A list of communications. content: application/json: schema: allOf: - title: Execution time type: object properties: execution_time: type: string example: 0.08853 seconds - type: object properties: communications: type: array items: $ref: '#/paths/~1v2~1communications~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/communication' operationId: get-communications post: tags: - Communications summary: Creates a new draft communication description: 'Draft communications belong to the user that created them (the owner). Note: this endpoint accepts publisher_ids or recipients, not both together ' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications~1%7Bid%7D~1content/put/requestBody/content/application~1json/schema' - type: object properties: name: type: string maxLength: 64 example: Awesome communication subject: type: string maxLength: 128 example: Wonderful subject from_name: type: string maxLength: 64 description: The from name to be used example: Joy O'Happy from_email: type: string format: email maxLength: 255 description: The from email to be used reply_to_email: type: string format: email maxLength: 255 description: The reply to email to be used type: type: string enum: - general - prospect_invitation default: general description: The purpose of email being sent campaigns: type: array maxItems: 180 uniqueItems: true items: type: string - $schema: http://json-schema.org/draft-04/schema oneOf: - type: object properties: recipients: type: array description: An array containing the emails of the recipients items: oneOf: - type: string format: email - type: object description: An object containing emails addresses and any applicable metadata required: - email_address properties: email_address: type: string format: email is_in_grouphigh: type: boolean description: Only available to emails of type prospect_invitation is_in_publisher_discovery: type: boolean description: Only available to emails of type prospect_invitation - type: object properties: publisher_ids: type: array description: An array containing ids of partner recipients items: type: string responses: '201': description: The new Communication object content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - $schema: http://json-schema.org/draft-04/schema type: object properties: communication: allOf: - $ref: '#/paths/~1v2~1communications~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/communication' - $ref: '#/paths/~1v2~1communications/post/requestBody/content/application~1json/schema/allOf/2' - $schema: http://json-schema.org/draft-04/schema type: object properties: hypermedia: type: object properties: links: type: object properties: content: type: string example: /v2/communications/{id}/content examples: response: value: execution_time: 0.08853 seconds communication: id: 100l06 name: Awesome communication subject: Wonderful subject type: general from_name: Joy O'Happy from_email: user@example.com reply_to_email: user@example.com send_date: '2020-07-23T10:02:53Z' timezone: Europe/London status: sent preview_url: http://... publisher_ids: - string hypermedia: links: content: /v2/communications/{id}/content operationId: create-communication /v2/communications/{id}: get: tags: - Communications summary: Retrieves a single communication description: Retrieves a communication for a given id parameters: - name: id in: path description: The ID of the communication required: true schema: type: string responses: '200': description: The Communication object content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: communication: allOf: - type: object properties: id: type: string example: 100l06 - $ref: '#/paths/~1v2~1communications/post/requestBody/content/application~1json/schema/allOf/1' - type: object properties: send_date: type: string format: date-time nullable: true description: Either a valid future date or the keyword `immediately` timezone: type: string description: The timezone of the "send_date" as listed here https://www.php.net/manual/en/timezones.php.
Ignored if the value of "send_date" is "immediately" example: Europe/London status: type: string enum: - draft - scheduled - sent example: sent description: The status of the communication preview_url: type: string example: http://... description: The URL with the preview html for sent and scheduled communications last_updated: type: string format: date-time operationId: get-communication put: tags: - Communications summary: Updates a draft communication description: Only the owner of the draft can update it. The recipients of the communication can be defined by a list of emails or by a list of existing partner ids parameters: - name: id in: path description: The ID of the communication required: true schema: type: string requestBody: required: true content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/post/requestBody/content/application~1json/schema/allOf/1' - $ref: '#/paths/~1v2~1communications/post/requestBody/content/application~1json/schema/allOf/2' responses: '201': description: The updated Communication object content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - $ref: '#/paths/~1v2~1communications~1%7Bid%7D/get/responses/200/content/application~1json/schema/allOf/1' operationId: update-communication delete: tags: - Communications summary: Deletes an existing draft communication description: Only the owner of the draft can delete it. parameters: - name: id in: path description: The ID of the communication to be deleted required: true schema: type: string responses: '204': description: The communication was deleted successfully. operationId: delete-communication /v2/communications/{id}/content: get: tags: - Communications summary: Returns the content of a communication description: Returns the HTML content of an existing communication. parameters: - name: id in: path description: The ID of the communication required: true schema: type: string responses: '200': description: The HTML content content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: html: type: string example: communication content unlayer_json: type: string nullable: true example: '{}' operationId: get-communication-content put: tags: - Communications summary: Updates the content of a communication description: Updates the HTML content of an existing communication. parameters: - name: id in: path description: The ID of the communication required: true schema: type: string requestBody: required: true content: application/json: schema: $schema: http://json-schema.org/draft-04/schema type: object properties: html: type: string description: The HTML contents of the communication example: Communication content unlayer_json: type: string minLength: 1 nullable: true description: The Unlayer JSON contents of the communication example: '{}' required: - html responses: '204': description: The HTML content was updated successfully operationId: update-communication-content /v2/communications/send-preview: post: tags: - Communications summary: Sends a communication preview requestBody: required: true content: application/json: schema: type: object properties: html: type: string description: The HTML contents of the communication recipients: type: array description: An array containing the emails of the recipients items: type: string responses: '204': description: Preview successfully sent description: Send a preview of a communication operationId: send-communication-preview /v2/communications/{id}/send: post: tags: - Communications summary: Sends or schedules a draft communication requestBody: required: true content: application/json: schema: type: object properties: send_date: type: string description: The date when the communication will be sent (at least 15 minutes in the future), or the string "immediately" for immediate sending example: '2019-06-17 12:34:56' timezone: type: string maxLength: 64 description: The timezone of the "send_date" as listed here https://www.php.net/manual/en/timezones.php.
Ignored if the value of "send_date" is "immediately" example: Europe/London responses: '204': description: Communication successfully sent description: Send a Communication operationId: send-communication parameters: - schema: type: string name: id in: path required: true description: The ID of the communication /v2/communications/{id}/cancel: delete: tags: - Communications summary: Cancels a scheduled communication description: 'Cancels the scheduling of a previously scheduled communication. This will change the communication status to draft. ' parameters: - name: id in: path description: The ID of the communication to be cancelled required: true schema: type: string responses: '204': description: The communication was cancelled successfully. operationId: cancel-communication /v2/communications/summary: get: tags: - Communications summary: Communications summary report description: Retrieves summary report for all sent communications. parameters: - in: query name: limit description: The number of records to retrieve schema: type: integer default: 100 - in: query name: offset description: Starting position schema: type: integer default: 0 responses: '200': description: A list of report items. content: application/json: schema: type: object properties: count: type: integer example: 17 limit: type: integer example: 100 offset: type: integer example: 0 summary: type: array items: type: object properties: communication_id: type: string example: 100l06 communication_name: type: string example: Communication name send_date: type: string format: date-time opens: type: int example: 100 unique_opens: type: int example: 80 not_opened: type: int example: 200 clicks: type: int example: 5 bounces: type: int example: 2 unsubscribes: type: int example: 10 spam: type: int example: 4 operationId: get-communicatons-report /v2/platform-communications/events: get: tags: - Platform Communications summary: Get platform events list description: Returns the available events for triggering platform communications responses: '200': description: A list of available events. content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: events: type: array items: type: object title: Platform event properties: id: type: string example: no_conversion_in_x_days name: type: string example: No new conversion after type: type: string enum: - partner - conversion example: conversion allows_recipients: type: boolean example: false required_placeholder: type: object properties: placeholder: type: string example: '[Pz-campaign-ref-code]' fallback: type: string example: campaign list operationId: get-platform-communication-events /v2/platform-communications: post: tags: - Platform Communications summary: Create platform communication description: Creates a platform communication that can be triggered automatically when a given event occurs requestBody: content: application/json: schema: type: object required: - event_id properties: event_id: type: string example: 100l01 html: type: string example: platform email content unlayer_json: type: string nullable: true minLength: 1 example: '{}' name: type: string example: Sign Up Confirmation subject: type: string maxLength: 128 example: Sign Up Confirmation from_name: type: string example: John Smith reply_to_email: type: string example: someone@partnerize.com event_properties: type: object example: days_elapsed: 10 disable: type: boolean responses: '201': description: The new platform communication object content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: platform_communication: $ref: '#/paths/~1v2~1platform-communications/get/responses/200/content/application~1json/schema/allOf/1/properties/platform_communications/items' operationId: create-platform-communication get: tags: - Platform Communications summary: Get platform communications list description: Returns all existing platform communications responses: '200': description: A list of platform communications. content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: platform_communications: type: array items: type: object properties: id: type: string example: 100l03 event_id: type: string example: 100l01 name: type: string example: Sign Up Confirmation subject: type: string example: Sign Up Confirmation from_name: type: string example: John Smith reply_to_email: type: string example: someone@partnerize.com updated_at: type: string format: date-time event_properties: type: object example: days_elapsed: 10 disable: type: boolean operationId: get-platform-communications /v2/platform-communications/{id}: delete: tags: - Platform Communications summary: Deletes an existing platform communication description: Deletes an existing platform communication parameters: - name: id in: path description: The ID of the platform communication to be deleted required: true schema: type: string responses: '204': description: The platform communication was deleted successfully. operationId: delete-platform-communication patch: tags: - Platform Communications summary: Update an existing platform communication content description: Updates an existing platform communication content requestBody: content: application/json: schema: type: object required: - html properties: html: type: string example: platform email content unlayer_json: type: string nullable: true minLength: 1 example: '{}' responses: '201': description: The updated platform communication object content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - $ref: '#/paths/~1v2~1platform-communications/post/responses/201/content/application~1json/schema/allOf/1' operationId: update-platform-communication /v2/platform-communications/{id}/content: get: tags: - Platform Communications summary: Returns the content of a platform communication description: Returns the HTML content of an existing platform communication. parameters: - name: id in: path description: The ID of the platform communication required: true schema: type: string responses: '200': description: The HTML content content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: html: type: string example: platform communication content unlayer_json: description: The Unlayer JSON contents of the platform communication type: string nullable: true example: '{}' operationId: get-platform-communication-content /v2/platform-communications/validate-content: post: tags: - Platform Communications summary: Validate content description: A helper endpoint which can be used to validate the html for a platform communication requestBody: required: true content: application/json: schema: type: object properties: html: type: string description: The HTML contents of the platform communication example: platform communication content unlayer_json: description: The Unlayer JSON contents of the platform communication type: string nullable: true minLength: 1 example: '{}' responses: '204': description: Valid html operationId: validate-platform-communication-content /v2/communication-placeholders: get: summary: Placeholders list description: Returns a list of all available placeholders tags: - Placeholders responses: '200': description: Placeholders list content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - type: object properties: placeholders: type: array items: title: Communication placeholder type: object description: Placeholder x-tags: - Placeholders properties: id: type: string example: contact_name name: type: string example: Contact name placeholder: type: string example: '[contact_name,fallback=]' operationId: get-communication-placeholders /v2/communication-templates: get: tags: - Communication Templates summary: Get a list of communication templates operationId: list-communication-template parameters: - in: query name: name schema: type: string required: false description: Name of template to search by - in: query name: source schema: type: string enum: - partnerize - unlayer required: false description: Source of the template to filter by responses: '200': description: Returns a list of communication templates content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - $schema: http://json-schema.org/draft-04/schema type: object properties: communication_templates: type: array items: allOf: - $ref: '#/paths/~1v2~1communication-templates~1%7Bid%7D/patch/requestBody/content/application~1json/schema/allOf/0/allOf/0' - type: object properties: network_id: type: string nullable: true unlayer_json: type: object nullable: 'true' default: null html: type: string nullable: 'true' default: null last_updated: type: string example: '2024-02-09T15:18:35+00:00' post: tags: - Communication Templates summary: Creates a new communication template operationId: create-communication-template requestBody: required: true content: application/json: schema: allOf: - $schema: http://json-schema.org/draft-04/schema type: object allOf: - $ref: '#/paths/~1v2~1communication-templates~1%7Bid%7D/patch/requestBody/content/application~1json/schema/allOf/0' - type: object required: - name - unlayer_json - html - thumbnail responses: '201': description: Returns the newly created communication template content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - $schema: http://json-schema.org/draft-04/schema type: object properties: communication_template: allOf: - $ref: '#/paths/~1v2~1communication-templates~1%7Bid%7D/patch/requestBody/content/application~1json/schema/allOf/0/allOf/0' - type: object properties: network_id: type: string last_updated: type: string example: '2024-02-09T15:18:35+00:00' /v2/communication-templates/{id}: get: tags: - Communication Templates summary: Get a single communication template operationId: read-communication-template parameters: - in: path name: id schema: type: string required: true description: ID of the template to get - in: query name: source schema: type: string enum: - partnerize - unlayer required: true description: Whether the template is from Partnerize or Unlayer responses: '200': description: '' content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - $ref: '#/paths/~1v2~1communication-templates/post/responses/201/content/application~1json/schema/allOf/1' patch: tags: - Communication Templates summary: Updates a communication template operationId: patch-communication-template parameters: - in: path name: id schema: type: string required: true description: ID of the template to patch requestBody: required: true content: application/json: schema: allOf: - $schema: http://json-schema.org/draft-04/schema type: object allOf: - $schema: http://json-schema.org/draft-04/schema type: object properties: id: type: string readOnly: true name: type: string minLength: 1 maxLength: 128 example: My comms template unlayer_json: type: object minLength: 1 html: type: string minLength: 1 visibility: type: string enum: - user - network default: user source: type: string enum: - partnerize - unlayer readOnly: true thumbnail: type: string description: The url for the communication template thumbnail - type: object properties: thumbnail: type: string minLength: 1 description: Absolute url for the image responses: '200': description: '' content: application/json: schema: allOf: - $ref: '#/paths/~1v2~1communications/get/responses/200/content/application~1json/schema/allOf/0' - $ref: '#/paths/~1v2~1communication-templates/post/responses/201/content/application~1json/schema/allOf/1' delete: tags: - Communication Templates summary: Delete a single communication template operationId: delete-communication-template parameters: - in: path name: id schema: type: string required: true description: ID of the Partnerize template to delete responses: '204': description: '' /v2/communication-templates/{id}/thumbnail: get: tags: - Communication Templates summary: Get a single communication template's thumbnail operationId: fetch-communication-template-thumbnail parameters: - in: path name: id schema: type: string required: true description: ID of the template to get - in: query name: source schema: type: string enum: - partnerize - unlayer required: true description: Whether the thumbnail is for a Partnerize or Unlayer template responses: '200': description: An image representing the template's thumbnail content: image/png: schema: type: string format: binary /v3/brand/{brand}/deeplink-domains: get: operationId: get_deeplink_domains summary: Fetches allowed deeplink domains for the given brand. description: 'Fetches allowed deeplink domains for a given brand. Results are ordered by domain name in ascending order. ' tags: - Deep link domains parameters: - name: brand in: path description: Brand ID to get allowed domains for required: true schema: type: string - name: limit in: query description: Limits the number of results returned. Defaults to 20 required: false schema: type: integer - name: offset in: query description: Offsets the results returned required: false schema: type: integer responses: '200': description: Domain(s) successfully found content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Deeplink domain response examples: - data: - brand_id: 1111l11 domain: partnerize.com created_by: 1111l22 created_at: '' hypermedia: pagination: total_page_count: 1 total_item_count: 1 first_page: /v3/brand/111l1/deeplink-domains?offset=0&limit=20 last_page: /v3/brand/111l1/deeplink-domains?offset=0&limit=20 next_page: null previous_page: null patch: operationId: add_deeplink_domains summary: Adds allowed deeplink domains for the given brand. description: 'Adds a number of allowed deeplink domains for the given Brand. A maximum of 100 domains can be added at once. ' tags: - Deep link domains parameters: - name: brand in: path description: Brand ID to modify allowed domains for required: true schema: type: string requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Deeplink domain request properties: allowed_domains: type: array items: type: string maxLength: 256 maxItems: 100 required: - allowed_domains minProperties: 1 additionalProperties: false responses: '204': description: Domain(s) successfully added delete: operationId: delete_deeplink_domains summary: Removes allowed deeplink domains for the given brand. description: 'Removes a number of allowed deeplink domains for the given Brand. A maximum of 100 domains can be removed at once. ' tags: - Deep link domains parameters: - name: brand in: path description: Brand ID to remove allowed domains for required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/paths/~1v3~1brand~1%7Bbrand%7D~1deeplink-domains/patch/requestBody/content/application~1json/schema' responses: '204': description: Domain(s) successfully removed /v3/brand/campaigns/{campaignID}/conversions/bulk: post: operationId: v3-conversion-bulk-update summary: Bulk update of conversions tags: - Campaign Conversions description: 'Allows for conversion update operations to be performed on conversions within a particular campaign. This can be achieved using the `conversion_id`, `conversion_item_id` or `conversion_reference` identifiers depending on what works best in the situation. Any changes to `status` at the `conversions` or `conversion_references` level will be applied to all items within that conversion, provided the individual item is allowed to be updated. Should you want to be more explicit with `status` (or any other field) updates then the `conversion_items` key allows this. **Note** Only one of the accepted parameters to the payload (`conversions`, `conversion_items`, or `conversion_references`) can be used at once, each allowing a maximum of 100,000 items. Deprecates `POST /campaign/{campaignID}/conversion` ' parameters: - name: campaignID in: path description: Id of the Campaign required: true schema: type: string requestBody: required: true content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Campaign Conversion Bulk Update Request Object definitions: job_reference: title: Job Reference description: Optional user provided job reference type: string maxLength: 256 conversion-update: $id: '#conversion-update' title: Property name is identifier type: object properties: status: type: string enum: - approved - rejected - pending - fraudulent reason: type: string description: Reason to indicate why a conversion or item was updated. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 255 ref_partnership_model_id: type: integer description: Partnership model ID. force_commission_recalculation: type: boolean description: Force commission values to be recalculated against commission rules. publisher_reference: type: string description: Reference for publisher. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 256 advertiser_reference: type: string description: Reference for advertiser. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 256 conversion_reference: type: string description: Reference for conversion. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 256 customer_reference: type: string description: Reference for customer. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 256 traffic_source_id: type: integer description: Traffic source ID. conversion_metric_id: type: integer description: Conversion meteric ID. customer_type: type: string description: Customer type. enum: - new - existing additionalProperties: false conversion-item-update: $id: '#conversion-item-update' title: Property name is identifier type: object properties: status: type: string enum: - approved - rejected - pending - fraudulent item_value: type: number minimum: 0 maximum: 99999999.9999 reason: type: string description: Reason to indicate why a conversion or item was updated. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 255 force_commission_recalculation: type: boolean description: Force commission values to be recalculated against commission rules. display_to_publisher: type: boolean description: Display conversion item to publishers. category: type: string description: Conversion item category. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 128 sku: type: string description: Conversion item SKU. pattern: ^[a-zA-Z0-9 :\-_.,;#]+$ maxLength: 512 additionalProperties: false properties: conversions: title: conversions type: object additionalProperties: $ref: '#/paths/~1v3~1brand~1campaigns~1%7BcampaignID%7D~1conversions~1bulk/post/requestBody/content/application~1json/schema/definitions/conversion-update' minProperties: 1 conversion_items: title: conversion items type: object additionalProperties: $ref: '#/paths/~1v3~1brand~1campaigns~1%7BcampaignID%7D~1conversions~1bulk/post/requestBody/content/application~1json/schema/definitions/conversion-item-update' minProperties: 1 conversion_references: title: conversion references type: object additionalProperties: $ref: '#/paths/~1v3~1brand~1campaigns~1%7BcampaignID%7D~1conversions~1bulk/post/requestBody/content/application~1json/schema/definitions/conversion-update' minProperties: 1 oneOf: - required: - conversions title: Conversions maxProperties: 1 example: conversions: 111111l1: status: approved 111111l2: status: rejected reason: cancelled order - required: - conversion_items title: Conversion Items maxProperties: 1 example: conversion_items: 111111l3: status: approved item_value: 12.34 111111l4: status: rejected reason: cancelled order - required: - conversion_references title: Conversion References maxProperties: 1 example: conversion_references: conversion_ref: status: approved additionalProperties: false responses: '202': description: The bulk request was successful and a job spawned content: application/json: schema: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema' '400': description: "Any errors that can be immediately determined are returned\ \ here, anything else will be handled in the job. \n\n# Error codes\n\ Possible reasons for a failure are listed in the table below.\n\n| Code\ \ | Description |\n|-|-|\n| 99B4BC14-8401-4A45-9AF5-CB79E4989C2E | `conversion_ids`\ \ supplied with `conversion_references` request, or non-standard IDs used\ \ for `conversions`/`conversion_items` |\n" content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Validation error properties: error: $schema: http://json-schema.org/draft-07/schema# type: object title: Standard error object properties: errors: type: array items: $schema: http://json-schema.org/draft-07/schema# type: object title: Standard error object properties: meta: type: object additionalProperties: true property: type: string type: type: string code: type: string message: type: string example: property: title type: validation_error code: campaign_title_unique message: Campaign name 'Carbon Offset 2' already exists meta: campaign_name: Carbon Offset 2 code: type: string message: type: string example: error: errors: - property: title type: validation code: validation_error message: title is required code: '400' message: Validation error /job/{jobID}: get: operationId: get_job_v1 summary: Get a single job (v1) description: 'Returns information about a single v1 job by the given ID. Once the `job` `status` is `complete` the job output can be retrieved from the path given in the `hypermedia` `response` (`/job/111111l11/response.csv` in the response samples). ' tags: - Jobs (v1) parameters: - name: jobID in: path description: Id of the job required: true schema: type: string responses: '200': description: Request success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v1 Job Response properties: job: type: object properties: job_id: type: string example: 111111l11 created_at: type: string example: '2018-11-13 20:20:39' completed_at: type: - string - 'null' example: '2018-11-13 20:20:55' created_by: type: string example: 111111l11 created_by_uri: type: string example: reporting/export/export/conversion_item.csv status: type: string example: complete percentage_complete: type: integer description: Integer 0-100 example: 100 reference: type: - string - 'null' example: myref response_within_retention: type: boolean example: true hypermedia: type: object properties: response: type: string example: /job/111111l11/response.csv update: type: string example: /job/111111l11 /v3/jobs: get: operationId: get_jobs summary: Get a list of jobs for the user description: Returns a list of jobs for the api user tags: - Jobs parameters: - name: type in: query description: Job type to filter by required: false schema: type: string - name: reference in: query description: 'Job reference to filter by. Performs a partial match, eg "partner" would match a reference of "partnerize", "dance-partner" and "partner". ' required: false schema: type: string - name: offset in: query description: Pagination offset required: false schema: type: integer default: 0 - name: limit in: query description: Pagination limit required: false schema: type: integer default: 20 responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Job task list properties: data: type: array items: $schema: http://json-schema.org/draft-07/schema# title: v3 Task Summary Object type: object properties: data: type: object properties: id: type: string created_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' started_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' completed_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' created_by_uri: type: string created_by: type: string created_by_username: type: string status: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/status' percentage_complete: type: integer type: type: string example: id: 111111l11 created_at: '2018-11-13T20:20:39+00:00' started_at: '2018-11-13T20:20:39+00:00' completed_at: '2018-11-13T20:20:39+00:00' created_by_uri: http://api.partnerize.tech/v3/campaigns/111111l1/conversions/bulk created_by: 1111l111 created_by_username: API User status: complete percentage_complete: 100 type: conversion_bulk_update hypermedia: links: self: v3/jobs/111111l11 tasks: v3/jobs/111111l11/tasks/111111l12 hypermedia: properties: pagination: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Hypermedia Task Pagination properties: total_count: type: integer first_page: type: string last_page: type: string next_page: type: string nullable: true previous_page: type: string nullable: true example: total_page_count: 5 total_item_count: 5 first_page: /jobs?offset=0&limit=100 last_page: /jobs?offset=400&limit=100 next_page: /jobs?offset=100&limit=100 previous_page: null example: data: - id: 111111l11 created_at: '2018-11-13T20:20:39+00:00' started_at: '2018-11-13T20:20:39+00:00' completed_at: '2018-11-13T20:20:39+00:00' created_by_uri: http://api.partnerize.tech/v3/campaigns/111111l1/conversions/bulk status: complete percentage_complete: 100 type: conversion_bulk_update hypermedia: links: self: v3/jobs/111111l11 tasks: v3/jobs/111111l11/tasks/111111l112 hypermedia: pagination: total_page_count: 5 total_item_count: 5 first_page: /jobs?offset=0&limit=100 last_page: /jobs?offset=400&limit=100 next_page: /jobs?offset=100&limit=100 previous_page: null /v3/jobs/{jobID}: get: operationId: get_job summary: Get a single job description: Returns information about a single v3 job by the given ID tags: - Jobs parameters: - name: jobID in: path description: Id of the job required: true schema: type: string responses: '200': description: Request success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Job Response properties: data: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Job Object properties: id: type: string reference: type: string created_at: definitions: date-time: type: string format: date-time description: 'ISO8601 format, for example: `"2018-11-13T20:20:39+00:00"`' interval: type: string pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$ description: 'ISO8601 durations format, for example: `"P2DT7H"` (2 days and 7 hours)' between-start-end: type: object required: - start - end properties: start: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at/definitions/date-time' end: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at/definitions/date-time' additionalProperties: false started_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' completed_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' created_by: type: string created_by_username: type: string created_by_uri: type: string status: $schema: http://json-schema.org/draft-07/schema# title: v3 Job Statuses type: string enum: - created - active - complete - failed percentage_complete: type: integer item_success_count: type: integer item_error_count: type: integer item_total_count: type: integer type: type: string example: id: 111111l11 created_at: '2018-11-13T20:20:39+00:00' started_at: '2018-11-13T20:20:39+00:00' completed_at: '2018-11-13T20:20:39+00:00' created_by_uri: https://api.partnerize.com/v3/campaigns/111111l1/conversions/bulk created_by: 1111l111 created_by_username: API User status: complete type: conversion_bulk_update percentage_complete: 100 item_success_count: 1 item_total_count: 4 item_error_count: 3 hypermedia: type: object properties: links: type: object properties: self: type: string example: /v3/jobs/111111l11 tasks: type: string example: /v3/jobs/111111l11/tasks /v3/jobs/{jobID}/tasks: get: operationId: get_job_tasks summary: Get tasks for a job description: Returns a list of tasks for a given job tags: - Jobs parameters: - name: jobID in: path description: Id of the job required: true schema: type: string - name: offset in: query description: Pagination offset required: false schema: type: integer default: 0 - name: limit in: query description: Pagination limit required: false schema: type: integer default: 20 responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Job task list properties: data: type: array items: $schema: http://json-schema.org/draft-07/schema# title: v3 Task Summary Object type: object properties: data: type: object properties: id: type: string status: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/status' hypermedia: type: object properties: links: type: string example: id: 111111l11 status: complete percentage_complete: 100 hypermedia: links: self: v3/jobs/111111l11/tasks/111111l12 hypermedia: properties: pagination: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Hypermedia Task Pagination properties: total_count: type: integer first_page: type: string last_page: type: string next_page: type: string nullable: true previous_page: type: string nullable: true example: total_page_count: 5 total_item_count: 5 first_page: /jobs/111111l11/tasks?offset=0&limit=100 last_page: /jobs/111111l11/tasks?offset=400&limit=100 next_page: /jobs/111111l11/tasks?offset=100&limit=100 previous_page: null example: data: - id: 111111l11 status: complete hypermedia: links: self: v3/jobs/111111l11/tasks/111111l112 hypermedia: pagination: total_page_count: 5 total_item_count: 5 first_page: /jobs/111111l11/tasks?offset=0&limit=100 last_page: /jobs/111111l11/tasks?offset=400&limit=100 next_page: /jobs/111111l11/tasks?offset=100&limit=100 previous_page: null /v3/jobs/{jobID}/tasks/{taskID}: get: operationId: get_task summary: Get detailed task information description: Returns detailed information for a given task tags: - Jobs parameters: - name: jobID in: path description: Id of the job required: true schema: type: string - name: taskID in: path description: Id of the task required: true schema: type: string responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Job Task properties: data: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Job Task Object properties: id: type: string job_id: type: string item_success_count: type: integer item_error_count: type: integer item_total_count: type: integer created_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' started_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' completed_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' status: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/status' result_data: type: string example: id: 111111l11 job_id: 111111l12 item_success_count: 1 item_total_count: 4 item_error_count: 3 created_at: '2018-11-13T20:20:39+00:00' started_at: '2018-11-13T20:20:39+00:00' completed_at: '2018-11-13T20:20:39+00:00' status: complete result_data: '{Result data generated by the completion of the job}' /v3/jobs/{jobID}/replay: post: operationId: replay_job summary: Replay a job description: Resubmits a job in to the queue for re-processing. Only jobs of type `conversion_bulk_update` can be replayed. tags: - Jobs parameters: - name: jobID in: path description: Id of the job required: true schema: type: string responses: '200': description: Request success content: application/json: schema: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema' /v3/jobs/{jobID}/tasks/{taskID}/replay: post: operationId: replay_job summary: Replay a job description: Resubmits a task in to the queue for re-processing. Only tasks of type `conversion_bulk_update` can be replayed. tags: - Jobs parameters: - name: jobID in: path description: Id of the job required: true schema: type: string - name: taskID in: path description: Id of the task required: true schema: type: string responses: '200': description: Request success content: application/json: schema: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D~1tasks~1%7BtaskID%7D/get/responses/200/content/application~1json/schema' /reporting/report_advertiser/campaign/{campaign_id}/conversion.{format}: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: Format for the response example: json in: path name: format required: true schema: enum: - json - xml type: string - description: Start date for data to be included in the report example: '2016-02-30T05:15:32Z' in: query name: start_date required: true schema: type: string - description: End date for data to be included in the report example: '2016-03-10T19:02:35Z' in: query name: end_date required: false schema: type: string - description: Restricts the results to one of the following - this hour, last hour, today, yesterday, this week, last week, last X days, this month, last month, this year, last year. example: yesterday in: query name: text_date required: false schema: type: string - description: Enforce a specified Timezone. example: Europe/London in: query name: timezone required: false schema: type: string - description: Filter the results by the specified currency example: USD in: query name: currency[] required: false schema: $ref: '#/components/schemas/Currency' - description: This parameter to run the report for conversions that have been updated. When you specify `last_modified` or `approved_at` the response will only include conversions that were last modified or approved at in a date within the report date range. example: last_modified in: query name: date_type required: false schema: type: string - description: 'Add a secondary pivot filter. You need to specify the pivot parameter name and the value to filter by. E.g. multipivot[publisher][]=111111l29. Supported values are: `publisher`, `product`, `advertiser_reference`.' example: value in: query name: multipivot[{pivot}][] required: false schema: type: string - description: Filter by statuses. Available values - approved, pending, rejected example: approved in: query name: statuses[] required: false schema: type: string - description: 'Include payment information. Omit parameter or false to exclude, which is the default. Fields included are: + payment_status + invoice_create_date + invoice_paid_date' example: true in: query name: include_payment_info required: false schema: type: boolean - description: Offset the results by a given amount. Defaults to 0. example: '0' in: query name: offset required: false schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: total_conversion_count: USD: 1 total_commission_value: USD: 44 total_publisher_commission: USD: 40 total_value: USD: 400 start_date_time_utc: '2019-08-10 00:00:00' end_date_time_utc: null start_date_time: '2020-05-13 00:00:00' end_date_time: '2020-05-13 00:00:00' limit: 300 meta_data: [] count: 1 execution_time: 1.97706 seconds conversions: - conversion_data: conversion_id: 111111l10 campaign_id: 111111l26 publisher_id: 111111l92 conversion_time: '2020-05-13 00:00:00' device_id: 111111l12 creative_type: 0 creative_id: 0 specific_creative_id: 0 currency: USD advertiser_reference: adrefc conversion_reference: AUTO-5ebc12334abb39.26532332 customer_type: null referer_ip: 33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23 source_referer: '' last_modified: '2020-05-13 15:28:51' conversion_type: 1 country: US customer_reference: custrefc ref_device_id: 2 ref_partnership_model_id: 2 ref_traffic_source_id: 3 ref_conversion_metric_id: 2 ref_user_context_id: 2 campaign_title: rubycampaigncoybwvsv publisher_name: null click: click_id: 111111l12 device_id: 111111l12 campaign_id: 111111l26 publisher_id: 111111l92 type: standard status: nibbled set_time: '2020-05-13 00:00:00' set_ip: 33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23 last_used: 1589383731 last_ip: 33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23 advertiser_reference: '' referer: '' creative_id: 0 creative_type: 0 specific_creative_id: 0 country: US ref_device_id: 2 ref_traffic_source_id: 3 ref_partnership_model_id: 2 ref_user_context_id: 2 ref_device: Desktop ref_traffic_source: Affiliate ref_partnership_model: CPA ref_user_context: Web clickref: 111111lk ref_conversion_metric: Standard ref_device: Desktop ref_partnership_model: CPA ref_traffic_source: Affiliate ref_user_context: Web conversion_value: conversion_value_id: 111111l10 conversion_status: pending value: 400 commission: 44 publisher_commission: 40 meta_data: gclid: adword_google_meta_data conversion_items: - conversion_item_id: 111111l10 sku: 123 category: Product item_value: 400 item_commission: 44 item_publisher_commission: 40 item_status: pending invoice_id: null last_update: '2020-05-13 15:28:51' display_to_publisher: 1 approved_at: null item_status_id: 1 reject_reason: null voucher_codes: [] meta_data: gclid: adword_google_meta_data was_disputed: false currency_original: '' currency_conversion_rate: '' conversion_lag: 0 clickref: 111111lk schema: $ref: '#/components/schemas/Brand_Conversions' description: OK tags: - Brand Conversions description: Return a mix of aggregated and basket/item level conversion data for a brand. operationId: brand-conversions summary: Retrieve a Brand Conversions Report /reporting/report_advertiser/campaign/{campaign_id}/click.{format}: get: parameters: - description: ID of the Campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: Format for the response example: json in: path name: format required: true schema: enum: - json - xml type: string - description: Start date for data to be included in the report example: '2016-02-30T05:15:32Z' in: query name: start_date required: true schema: type: string - description: End date for data to be included in the report example: '2016-03-10T19:02:35Z' in: query name: end_date required: false schema: type: string - description: Restricts the results to one of the following - this hour, last hour, today, yesterday, this week, last week, last X days, this month, last month, this year, last year. example: yesterday in: query name: text_date required: false schema: type: string - description: Enforce a specified Timezone. example: Europe/London in: query name: timezone required: false schema: type: string - description: Filter the results by the specified currency example: USD in: query name: currency[] required: false schema: $ref: '#/components/schemas/Currency' - description: This parameter to run the report for conversions that have been updated. When you specify `last_modified` or `approved_at` the response will only include conversions that were last modified or approved at in a date within the report date range. example: last_modified in: query name: date_type required: false schema: type: string - description: 'Add a secondary pivot filter. You need to specify the pivot parameter name and the value to filter by. E.g. multipivot[publisher][]=111111l29. Supported values are: `publisher`, `product`, `advertiser_reference`.' example: value in: query name: multipivot[{pivot}][] required: false schema: type: string - description: Filter by statuses. Available values - approved, pending, rejected example: approved in: query name: statuses[] required: false schema: type: string - description: Offset the results by a given amount. Defaults to 0. example: '0' in: query name: offset required: false schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: unique_click_count: 2 start_date_time_utc: '2019-08-10 00:00:00' end_date_time_utc: null start_date_time: '2020-05-13 00:00:00' end_date_time: '2020-05-13 00:00:00' limit: 300 offset: 0 count: 2 execution_time: 0.50885 seconds clicks: - click: click_id: 111111l11 device_id: 111111l11 campaign_id: 111111l26 publisher_id: 111111l92 type: standard status: nibbled set_time: '2020-05-13 00:00:00' set_ip: 33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23 last_used: '2020-05-13 15:28:52' last_ip: 33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23 advertiser_reference: '' referer: '' creative_id: 0 creative_type: 0 specific_creative_id: 0 country: RU ref_device_id: 2 ref_traffic_source_id: 3 ref_partnership_model_id: 2 ref_user_context_id: 2 clickref: 111111lj publisher_name: null - click: click_id: 111111l12 device_id: 111111l12 campaign_id: 111111l26 publisher_id: 111111l92 type: standard status: nibbled set_time: '2020-05-13 00:00:00' set_ip: 33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23 last_used: '2020-05-13 15:28:51' last_ip: 33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23 advertiser_reference: '' referer: '' creative_id: 0 creative_type: 0 specific_creative_id: 0 country: US ref_device_id: 2 ref_traffic_source_id: 3 ref_partnership_model_id: 2 ref_user_context_id: 2 clickref: 111111lk publisher_name: null schema: $ref: '#/components/schemas/Brand_Clicks' description: OK tags: - Brand Clicks description: Return a mix of aggregated and basket/item level click data for a brand. operationId: brand-clicks summary: Retrieve a Brand Clicks Report /reporting/export/export/click.csv: get: parameters: - description: ID of the campaign. You must provide either this parameter or `publisher_id`. example: 10l176 in: query name: campaign_id required: true schema: type: string - description: ID of the partner. You must provide either this parameter or `campaign_id` example: 1l1007802 in: query name: publisher_id required: true schema: type: string - description: Start date for data to be included in the report example: '2016-02-30T05:15:32Z' in: query name: start_date required: true schema: type: string - description: End date for data to be included in the report example: '2016-03-10T19:02:35Z' in: query name: end_date required: true schema: type: string - description: Force a specified Timezone example: Europe/London in: query name: timezone required: false schema: type: string - description: When used in conjunction with limit=0 send a link to the CSV when generation is complete example: me@example.com in: query name: complete_email required: false schema: type: string - description: When set to zero, attempt to download everything example: '0' in: query name: limit required: false schema: type: string - description: Add a prefix to the report filename example: JanSales in: query name: export_reference required: false schema: type: string - description: '+ `UTF-8` - Default encoding + `UTF-16`' example: UTF-8 in: query name: encoding required: false schema: type: string - description: 'Choose the delimiter for separating values + comma + tab + pipe' example: comma in: query name: delimiter required: false schema: type: string responses: '200': content: application/octet-stream; charset=UTF-8: examples: response: value: 'click_id,cookie_id,campaign_id,publisher_id,status,set_time,set_ip,last_used,last_ip,advertiser_reference,referer,creative_id,creative_type,specific_creative_id,country,publisher_name 111111l2210,111111l2136,10l176,1l1007802,nibbled,"2016-03-02 10:11:36",127.0.0.1,"2016-06-17 19:13:09",127.0.0.1,,,0,0,0,GB,apipublisher123 ' description: OK tags: - Exports description: Request a CSV for a granular Click report for the defined Campaign or Partner and within the requested time period. operationId: Export Clicks summary: Export a Clicks Report /reporting/export/export/conversion.csv: get: parameters: - description: ID of the campaign. You must provide either this parameter or `publisher_id`. example: 10l176 in: query name: campaign_id required: true schema: type: string - description: ID of the partner. You must provide either this parameter or `campaign_id`. example: 1l1007802 in: query name: publisher_id required: true schema: type: string - description: Start date for data to be included in the report example: '2016-02-30T05:15:32Z' in: query name: start_date required: true schema: type: string - description: End date for data to be included in the report example: '2016-03-10T19:02:35Z' in: query name: end_date required: true schema: type: string - description: 'Alter the context of what the dates ranges apply to + standard - The default selection, range is based on conversion_time + approved_at - Alternative date range, which is based on the approved time of conversion items' example: standard in: query name: date_type required: false schema: type: string - description: Filter on a specific currency example: GBP in: query name: currency[] required: false schema: type: string - description: Filter on a specific conversion_id example: 1l28718278 in: query name: conversion_id required: false schema: type: string - description: Filter on a specific conversion_reference value example: ORDER872137 in: query name: conversion_reference required: false schema: type: string - description: Filter on a specific conversion metric, use an array for multiple example: '2' in: query name: ref_conversion_metric_id required: false schema: type: string - description: Force a specified Timezone example: Europe/London in: query name: timezone required: false schema: type: string - description: When used in conjunction with limit=0 send a link to the CSV when generation is complete example: me@example.com in: query name: complete_email required: false schema: type: string - description: When set to zero, attempt to download everything example: '0' in: query name: limit required: false schema: type: string - description: Add a prefix to the report filename example: JanSales in: query name: export_reference required: false schema: type: string - description: '+ `UTF-8` - Default encoding + `UTF-16`' example: UTF-8 in: query name: encoding required: false schema: type: string - description: 'Choose the delimiter for separating values + comma + tab + pipe' example: comma in: query name: delimiter required: false schema: type: string responses: '200': content: application/octet-stream; charset=UTF-8: examples: response: value: 'conversion_id,campaign_id,publisher_id,conversion_date,conversion_date_time,click_time,click_date,click_date_time,currency,advertiser_reference,conversion_reference,referer_ip,source_referer,campaign_title,publisher_name,conversion_status,conversion_lag,value,commission,publisher_commission,creative_type,creative_id,specific_creative_id,customer_type,was_disputed,cookie_id,country,currency_original,currency_conversion_rate,customer_reference,camref 111111l3919676,10l176,1l1007802,2016-03-02,"2016-03-02 10:22:02",10:11:36,2016-03-02,"2016-03-02 10:11:36",EUR,,AUTO-57643db548165,127.0.0.1,,"API Campaign Demo",apipublisher123,pending,626,90.92,1.0001,0.9092,0,0,0,,,111111l2136,GB,,,,1l3v9UA ' description: OK tags: - Exports description: Request a CSV for a granular Conversion report for the defined Campaign or Partner and within the requested time period. This report will give you details of orders at the basket level operationId: Export Conversions summary: Export Conversions Report /reporting/export/export/conversion_item.csv: get: parameters: - description: ID of the campaign. You must provide either this parameter or `publisher_id`. example: 10l176 in: query name: campaign_id required: true schema: type: string - description: ID of the partner. You must provide either this parameter or `campaign_id` example: 1l1007802 in: query name: publisher_id required: true schema: type: string - description: Start date for data to be included in the report example: '2016-02-30T05:15:32Z' in: query name: start_date required: true schema: type: string - description: End date for data to be included in the report example: '2016-03-10T19:02:35Z' in: query name: end_date required: true schema: type: string - description: 'Alter the context of what the dates ranges apply to + standard - The default selection, range is based on conversion_time + approved_at - Alternative date range, which is based on the approved time of conversion items' example: standard in: query name: date_type required: false schema: type: string - description: Filter on a specific currency example: GBP in: query name: currency[] required: false schema: type: string - description: Filter on a specific conversion_id example: 1l28718278 in: query name: conversion_id required: false schema: type: string - description: Filter on a specific conversion_reference value example: ORDER872137 in: query name: conversion_reference required: false schema: type: string - description: Filter on a specific conversion metric, use an array for multiple example: '2' in: query name: ref_conversion_metric_id required: false schema: type: string - description: Force a specified Timezone example: Europe/London in: query name: timezone required: false schema: type: string - description: 'Include payment information. Omit parameter or false to exclude, which is the default. Fields included are: + payment_status + invoice_create_date + invoice_paid_date' example: true in: query name: include_payment_info required: false schema: type: boolean - description: When used in conjunction with limit=0 send a link to the CSV when generation is complete example: me@example.com in: query name: complete_email required: false schema: type: string - description: When set to zero, attempt to download everything example: '0' in: query name: limit required: false schema: type: string - description: Add a prefix to the report filename example: JanSales in: query name: export_reference required: false schema: type: string - description: '+ `UTF-8` - Default encoding + `UTF-16`' example: UTF-8 in: query name: encoding required: false schema: type: string - description: 'Choose the delimiter for separating values + comma + tab + pipe' example: comma in: query name: delimiter required: false schema: type: string responses: '200': content: application/octet-stream; charset=UTF-8: examples: response: value: 'conversion_id,campaign_id,publisher_id,conversion_date,conversion_date_time,click_time,click_date,click_date_time,currency,advertiser_reference,conversion_reference,referer_ip,source_referer,campaign_title,publisher_name,conversion_status,conversion_lag,value,commission,publisher_commission,creative_type,creative_id,specific_creative_id,customer_type,was_disputed,cookie_id,country,currency_original,currency_conversion_rate,conversion_item_id,sku,category,item_value,item_commission,item_publisher_commission,item_status,item_status_id,reject_reason,last_update,voucher_codes,customer_reference,camref,invoice_id,meta_item_cabin_code,meta_item_departure_date,meta_item_dest,meta_item_device,meta_item_origin,meta_item_passenger,meta_item_payment_method,meta_item_product_ids,meta_item_return_date 111111l3919676,10l176,1l1007802,2016-03-02,"2016-03-02 10:22:02",10:11:36,2016-03-02,"2016-03-02 10:11:36",EUR,,AUTO-57643db548165,127.0.0.1,,"API Campaign Demo",apipublisher123,pending,626,90.92,1.0001,0.9092,0,0,0,,,111111l2136,GB,,,111111l4118583,,,90.92,1.0001,0.9092,pending,1,,"2016-06-17 19:13:09",,,1l3v9UA,,,,,,,,,, ' description: OK tags: - Exports description: Request a CSV for a granular Conversion report which includes all individual items for the defined Campaign or Partner and within the requested time period. In Conversion Item reports you will be able to see details of each item including individual item’s commission and value as each item will be listed on its own row within the report. operationId: Export Conversion Items summary: Export Conversion Items Report /campaign/{campaign_id}/reporting/meta/reports: get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: count: 143 execution_time: 0.09004 seconds reports: - report: campaign_id: '300685' completed_at: 'null' created_at: '2017-07-13 10:20:50' created_by: '300740' end_date: '2017-01-01 00:00:00' filter: - operator: '=' property: status value: approved filter_meta_conversion: - operator: '=' property: item_code value: P-123 filter_meta_item: - operator: in property: hotel_name value: - marriott - travelodge - premier inn id: 11l011 job_id: 11l32133 name: Test Report output_currency: GBP start_date: '2016-01-01 00:00:00' status: created updated_at: 'null' schema: properties: count: description: Number of delivered records type: number execution_time: description: Request duration time type: string reports: items: properties: report: properties: campaign_id: type: string completed_at: type: string created_at: type: string created_by: type: string end_date: type: string filter: type: array filter_meta_conversion: type: array filter_meta_item: type: array id: type: string job_id: type: string name: type: string output_currency: $ref: '#/components/schemas/Currency' start_date: type: string status: enum: - created - completed - running - aborted type: string updated_at: type: string type: object type: object type: array type: object description: OK tags: - Reporting on Meta data description: '' operationId: List all Meta Reports for a Campaign summary: List all Meta Reports for a Campaign post: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '201': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.09004 seconds report: campaign_id: '300685' completed_at: 'null' created_at: '2017-07-13 10:20:50' created_by: '300740' end_date: '2017-01-01 00:00:00' filter: - operator: '=' property: status value: approved filter_meta_conversion: - operator: '=' property: item_code value: P-123 filter_meta_item: - operator: in property: hotel_name value: - marriott - travelodge - premier inn id: 11l011 job_id: 11l32133 name: Test Report output_currency: GBP start_date: '2016-01-01 00:00:00' status: created updated_at: 'null' schema: properties: execution_time: description: Request duration time type: string report: properties: campaign_id: type: string completed_at: type: string created_at: type: string created_by: type: string end_date: type: string filter: items: {} type: array filter_meta_conversion: items: {} type: array filter_meta_item: items: {} type: array id: type: string job_id: type: string name: type: string output_currency: $ref: '#/components/schemas/Currency' start_date: type: string status: enum: - created - completed - running - aborted type: string updated_at: type: string type: object type: object description: Created tags: - Reporting on Meta data operationId: Create Meta Report requestBody: content: application/json: schema: example: end_date: '2017-01-01 00:00:00' filter: - operator: '=' property: status value: approved filter_meta_conversion: - operator: '=' property: item_code value: P-123 filter_meta_item: - operator: in property: hotel_name value: - marriott - travelodge - premier inn name: Test Report output_currency: GBP start_date: '2016-01-01 00:00:00' properties: filter: description: The filter options for the report type: array filter_meta_conversion: description: The conversion filter options for the report type: array filter_meta_item: description: The item filter options for the report type: array name: description: Name of the report type: string output_currency: description: Requested currency for aggregated results. Default value will be Campaign default currency $ref: '#/components/schemas/Currency' start_date: description: Start Date of the report type: string end_date: description: End Date of the report type: string required: - name - start_date - end_date - filter - filter_meta_conversion - filter_meta_item type: object summary: Create a Meta Report for a Campaign /campaign/{campaign_id}/reporting/meta/reports/{report_id}: delete: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the report example: '123' in: path name: report_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: delete_report: success: true execution_time: 0.09004 seconds schema: properties: delete_report: properties: success: type: boolean type: object execution_time: description: Request duration time type: string type: object description: OK tags: - Reporting on Meta data operationId: Delete Meta Report summary: Delete a Meta Report for a Campaign get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the report example: '123' in: path name: report_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.09004 seconds report: campaign_id: '300685' completed_at: 'null' created_at: '2017-07-13 10:20:50' created_by: '300740' end_date: '2017-01-01 00:00:00' filter: - operator: '=' property: status value: approved filter_meta_conversion: - operator: '=' property: item_code value: P-123 filter_meta_item: - operator: in property: hotel_name value: - marriott - travelodge - premier inn id: 11l011 job_id: 11l32133 name: Test Report output_currency: GBP start_date: '2016-01-01 00:00:00' status: created updated_at: 'null' schema: properties: execution_time: description: Request duration time type: string report: properties: campaign_id: type: string completed_at: type: string created_at: type: string created_by: type: string end_date: type: string filter: items: {} type: array filter_meta_conversion: items: {} type: array filter_meta_item: items: {} type: array id: type: string job_id: type: string name: type: string output_currency: $ref: '#/components/schemas/Currency' start_date: type: string status: enum: - created - completed - running - aborted type: string updated_at: type: string type: object type: object description: OK tags: - Reporting on Meta data operationId: Retrieve Meta Report summary: Retrieve a Meta Report for a Campaign /campaign/{campaign_id}/reporting/meta/reports/{report_id}/results: get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: ID of the report example: '123' in: path name: report_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: execution_time: 0.09004 seconds report_result: '{"hotel_name":"marriott"}': commission: 268761.889889 count: 3 currency: JPY ecpa: 11654146.437911 order_value: 3839455.569847 partner_commission: 268761.889889 schema: properties: execution_time: description: Request duration time type: string report_result: properties: '{"hotel_name":"marriott"}': properties: commission: type: number count: type: number currency: type: string ecpa: type: number order_value: type: number partner_commission: type: number type: object type: object type: object description: OK tags: - Reporting on Meta data description: The endpoint allows you to retrieve the results of a specified Meta Report for a Campaign. The endpoint supports `.csv` format. Use `../campaign/{campaign_id}/reporting/meta/reports/{report_id}/results.csv` to export the results as a csv file. operationId: View Meta Report Results summary: View the results of a Meta Report for a Campaign. /campaign/{campaign_id}/reporting/meta/values: get: parameters: - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: meta_values: conversion: conversion_key_name_1: - value_1 - value_2 - value_3 item: item_key_name_1: - value_1 - value_2 - value_3 schema: properties: meta_values: properties: conversion: description: Value list for Conversion level properties: conversion_key_name_1: items: type: string type: array type: object item: description: Value list for Item level properties: item_key_name_1: items: type: string type: array type: object type: object type: object description: OK tags: - Reporting on Meta data operationId: List Meta Values summary: List all Meta Values for a Campaign /campaign/{campaign_id}/reporting/meta/whitelist: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: whitelist: conversion: - conversion_key_name_1 - conversion_key_name_2 item: - item_key_name_1 - item_key_name_2 schema: properties: whitelist: description: Key list for Conversion level properties: conversion: items: type: string type: array item: description: Key list for Item level items: type: string type: array type: object type: object description: OK tags: - Reporting on Meta data operationId: List Meta Whitelist Keys summary: List all Meta Whitelist Keys for a Campaign /v2/campaigns/{campaign_id}/fraud/incidents: parameters: - name: campaign_id in: path description: Campaign ID required: true schema: type: string get: summary: List Incidents tags: - Incidents parameters: - name: partner_id in: query description: Partner ID to filter required: false schema: type: string - name: ip_address in: query description: IP address to filter required: false schema: type: string - name: metric in: query description: 'Filter the query by incident `metric`. This parameter must be used in conjunction with `type`. ' required: false schema: type: string enum: - volume_clicks - volume_conversions - conversion_ratio - basket_variability_sku - conversion_value - ttc - name: type in: query description: 'Filter the query by incident `type`. This parameter must be used in conjunction with `metric`. ' required: false schema: type: string enum: - partner - conversion - ip_address - name: status in: query description: Filter the query by incident `status`. required: false schema: type: string enum: - active - deleted - name: start_date in: query description: Only include incidents after this date. required: false schema: type: string format: date - name: end_date in: query description: Only include incidents before this date. required: false schema: type: string format: date - name: cursor_id in: query description: Cursor used for pagination. required: false schema: type: string - name: limit in: query description: Limit the number of incidents returned. required: false schema: type: integer responses: '200': description: OK content: application/json: schema: properties: incidents: description: A plurality of incident items: oneOf: - $ref: '#/components/schemas/Fraud_Incident_Type_Partner' - $ref: '#/components/schemas/Fraud_Incident_Type_IP_Address' limit: description: The number of Incidents to be returned in the response. Used for pagination. type: integer cursor_id: description: The current cursor_id, representing the first Incident ID in the response set. Used for pagination. type: string hypermedia: properties: links: type: object title: Hypermedia Pagination description: Fraud Hypermedia. Provides URIs for pagination. required: - links properties: pagination: type: object properties: previous_page: type: string readOnly: true description: The previous page in the result set. next_page: type: string readOnly: true description: The next page in the result set. examples: Incidents: value: limit: 1 cursor_id: 1234l12345678 incidents: - id: 1234l12345678 metric: conversion_value type: partner date: '2019-11-01' time_window: 1 partner: id: 1001l1111 name: PZ Finance status: active created_at: '2020-04-01T00:00:00.000Z' deleted_at: '2020-04-01T00:00:00.000Z' hypermedia: pagination: previous_page: v2/campaigns/111111/fraud/incidents?limit=1&cursor_id=1234l12345677 next_page: v2/campaigns/111111/fraud/incidents?limit=1&cursor_id=1234l12345679 '400': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Bad Status: value: error: errors: - type: error code: invalid_status message: No status with the name `status` was found code: 400 message: Bad Request Bad Metric: value: error: errors: - type: error code: invalid_metric message: No metric with the name `metric` was found code: 400 message: Bad Request Bad Metric Type: value: error: errors: - type: error code: invalid_metric_type message: No metric type of `metric_type` was found code: 400 message: Bad Request Bad Request: value: error: errors: - type: error code: invalid_params message: If you specify a metric filter, you must also specify type code: 400 message: Bad Request '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '503': description: Fraud Service Unavailable content: application/json: examples: Fraud Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' description: Get all incidents that are not dismissed ordered by date descending operationId: get-incidents /v2/campaigns/{campaign_id}/fraud/metrics: parameters: - name: campaign_id in: path description: Campaign ID required: true schema: type: string - name: start_date in: query description: Only count incidents after this date. required: false schema: type: string format: date - name: end_date in: query description: Only count incidents before this date. required: false schema: type: string format: date get: summary: List Metrics tags: - Metrics responses: '200': description: OK content: application/json: schema: title: Metrics Response type: object description: Metrics List Response required: - metrics - count properties: metrics: title: Metrics description: A plurality of Metric type: array items: title: Metric type: object description: A metric is a measurement by which incidents are triggered required: - id - metric - type - count - last_raised properties: id: type: string description: The Metric ID metric: type: string enum: - volume_clicks - volume_conversions - conversion_ratio - basket_variability_sku - conversion_value - ttc description: The Metric Name type: type: string enum: - partner - conversion - ip_address description: The Type of Metric count: type: integer minimum: 0 description: How many times this Metric has been raised last_raised: type: string format: date description: When was this Metric last raised count: type: integer minimum: 0 description: Number of Metrics in the Response '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '503': description: Fraud Service Unavailable content: application/json: examples: Fraud Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' operationId: get-fraud-metrics description: Get Fraud Metrics for the campaign, including a count of each /v2/campaigns/{campaign_id}/fraud/incidents/{incident_id}: parameters: - name: campaign_id in: path description: Campaign ID required: true schema: type: string - name: incident_id in: path description: Incident ID required: true schema: type: string get: summary: Get Incident tags: - Incidents responses: '200': description: OK content: application/json: schema: properties: execution_time: type: string incident: oneOf: - $ref: '#/components/schemas/Fraud_Incident_Metric_Basket' - $ref: '#/components/schemas/Fraud_Incident_Metric_Basic' - $ref: '#/components/schemas/Fraud_Incident_Metric_Conversion_Value' - $ref: '#/components/schemas/Fraud_Incident_Metric_Ttc' hypermedia: properties: links: type: object $ref: '#/paths/~1v2~1campaigns~1%7Bcampaign_id%7D~1fraud~1incidents/get/responses/200/content/application~1json/schema/properties/hypermedia/properties/links' examples: Volume Clicks Incident: value: incident: id: 1234l12345678 metric: volume_clicks type: partner date: '2019-11-01' time_window: 1 partner: id: 1001l1111 name: PZ Finance status: active created_at: '2020-04-01T00:00:00.000Z' deleted_at: '2020-04-01T00:00:00.000Z' data: threshold: 100 value: 150 hypermedia: links: reject-partner: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner Volume Conversions Incident: value: incident: id: 1234l12345678 metric: volume_conversions type: partner date: '2019-11-01' time_window: 1 partner: id: 1001l1111 name: PZ Finance status: active created_at: '2020-04-01T00:00:00.000Z' deleted_at: '2020-04-01T00:00:00.000Z' data: threshold: 101 value: 150 hypermedia: links: reject-partner: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner Conversion Ratio Incident: value: incident: id: 1234l12345678 metric: conversion_ratio type: partner date: '2019-11-01' time_window: 1 partner: id: 1001l1111 name: PZ Finance status: active created_at: '2020-04-01T00:00:00.000Z' deleted_at: '2020-04-01T00:00:00.000Z' data: threshold: 100 value: 150 hypermedia: links: reject-partner: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner Conversion Value Incident: value: incident: id: 1234l12345678 metric: conversion_value type: partner date: '2019-11-01' time_window: 1 partner: id: 1001l1111 name: PZ Finance status: active created_at: '2020-04-01T00:00:00.000Z' deleted_at: '2020-04-01T00:00:00.000Z' data: conversion_reference: 1111l1234 threshold: 100 value: 150 currency: USD conversion_items: - id: item1 sku: skuValue1 category: categoryValue1 status: approved - id: item2 sku: skuValue2 category: categoryValue2 status: pending hypermedia: links: reject-conversions: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-conversions pend-conversions: v2/campaigns/111111/fraud/incidents/1234l12345678/pend-conversions reject-partner: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner Time To Conversion Incident: value: incident: id: 1234l12345678 metric: ttc type: partner date: '2019-11-01' time_window: 1 partner: id: 1001l1111 name: PZ Finance status: active created_at: '2020-04-01T00:00:00.000Z' deleted_at: '2020-04-01T00:00:00.000Z' data: conversion_reference: 1111l1234 threshold: 100 value: 150 conversion_items: - id: item1 sku: skuValue1 category: categoryValue1 status: approved - id: item2 sku: skuValue2 category: categoryValue2 status: pending hypermedia: links: reject-conversions: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-conversions pend-conversions: v2/campaigns/111111/fraud/incidents/1234l12345678/pend-conversions reject-partner: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner Identical Purchases Incident: value: incident: id: 1234l12345678 metric: basket_variability_sku type: partner date: '2019-11-01' time_window: 1 partner: id: 1001l1111 name: PZ Finance status: active created_at: '2020-04-01T00:00:00.000Z' deleted_at: '2020-04-01T00:00:00.000Z' data: threshold: 200 value: 245 total: 1000 conversions: - conversion_reference: 1111l1234 count: 245 items: - id: item1 sku: skuValue1 category: categoryValue1 status: approved - id: item2 sku: skuValue2 category: categoryValue2 status: pending hypermedia: links: reject-partner: v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Entity Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: basic: value: error: errors: - type: error code: entity_not_found message: Incident not found for id 'string' code: 404 message: Not Found '503': description: Fraud Service Unavailable content: application/json: examples: Fraud Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' description: Get a specific incident operationId: get-incident delete: summary: Delete Incident tags: - Incidents responses: '204': description: No Content '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Not Found: value: error: errors: - type: error code: entity_not_found message: Incident not found for id 'string' code: 404 message: Not Found '503': description: Service Unavailable content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Fraud Detection Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable API Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'API' is currently unavailable code: 503 message: Remote Service Unavailable description: Delete a specific incident operationId: delete-incident /v2/campaigns/{campaign_id}/fraud/incidents-aggregation: parameters: - name: campaign_id in: path description: Campaign ID required: true schema: type: string - name: start_date in: query description: Only include incidents after this date. required: true schema: type: string format: date - name: end_date in: query description: Only include incidents before this date. required: true schema: type: string format: date get: summary: Get Incidents Aggregation tags: - Incidents responses: '200': description: OK content: application/json: schema: title: GET Incidents Aggregation Response type: object description: This is the response to a GET incidents aggregation call on the PzAPI. required: - data properties: data: type: array items: type: object required: - date_time_range - volume_clicks - volume_conversions - conversion_ratio - basket_variability_sku - conversion_value - ttc properties: date_time_range: type: object required: - start - end properties: start: type: string end: type: string volume_clicks: type: integer volume_conversions: type: integer conversion_ratio: type: integer basket_variability_sku: type: integer conversion_value: type: integer ttc: type: integer examples: Incidents: value: data: - date_time_range: start: '2019-10-02T00:00:00.000Z' end: '2019-10-03T00:00:00.000Z' volume_clicks: 10 volume_conversions: 20 conversion_ratio: 15 basket_variability_sku: 25 conversion_value: 30 ttc: 35 - date_time_range: start: '2019-10-03T00:00:00.000Z' end: '2019-10-04T00:00:00.000Z' volume_clicks: 11 volume_conversions: 21 conversion_ratio: 16 basket_variability_sku: 26 conversion_value: 31 ttc: 36 - date_time_range: start: '2019-10-04T00:00:00.000Z' end: '2019-10-05T00:00:00.000Z' volume_clicks: 12 volume_conversions: 22 conversion_ratio: 17 basket_variability_sku: 27 conversion_value: 32 ttc: 37 '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Entity Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: basic: value: error: errors: - type: error code: entity_not_found message: Incident not found for id 'string' code: 404 message: Not Found '503': description: Fraud Service Unavailable content: application/json: examples: Fraud Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' description: Get an aggregated total of incidents by day operationId: get-incidents-aggregation /v2/campaigns/{campaign_id}/fraud/incidents/{incident_id}/reject-partner: parameters: - name: campaign_id in: path description: Campaign ID required: true schema: type: string - name: incident_id in: path description: Incident ID required: true schema: type: string post: summary: Reject Partner operationId: fraud-reject-partner responses: '204': description: OK '400': description: Unable to Reject Partner content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unable to Reject Partner: value: error: errors: - type: error code: partner_not_rejected message: The Partner was not rejected code: 400 message: Bad Request '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Not Found: value: error: errors: - type: error code: entity_not_found message: Incident not found for id 'string' code: 404 message: Not Found '503': description: Service Unavailable content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Fraud Detection Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable API Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'API' is currently unavailable code: 503 message: Remote Service Unavailable tags: - Incidents description: Reject a Partner due to fraudulent claims. This means that the partner will no longer be valid for this Campaign /v2/campaigns/{campaign_id}/fraud/whitelisted-partners: parameters: - name: campaign_id in: path description: Campaign ID required: true schema: type: string get: summary: Get Whitelisted Partners tags: - Partner Whitelisting responses: '200': description: OK content: application/json: schema: title: Partner whitelist type: object description: A collection of whitelisted partners required: - execution_time - count - whitelisted-partners properties: execution_time: type: string count: type: integer example: 1 whitelisted-partners: type: array title: Partner Collection description: A collection of partners items: type: object required: - partner_id - partner_name properties: partner_id: type: string description: The ID of this partner. partner_name: type: string description: Human readable partner name. '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '503': description: Fraud Service Unavailable content: application/json: examples: Fraud Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' operationId: get-whitelisted-partners description: Retrieve all whitelisted partners post: summary: Whitelist Partner operationId: fraud-whitelist-partner requestBody: content: application/json: schema: type: object properties: partner_id: type: string responses: '200': description: Successfully whitelisted partner content: application/json: schema: type: object properties: partner_id: type: string campaign_id: type: string '400': description: Unable to Whitelist Partner content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unable to Whitelist Partner: value: error: errors: - type: error code: partner_not_whitelisted message: The partner was not whitelisted code: 400 message: Bad Request '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Not Found: value: error: errors: - type: error code: entity_not_found message: Partner not found for id '{id}' code: 404 message: Not Found '503': description: Service Unavailable content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Fraud Detection Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable API Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'API' is currently unavailable code: 503 message: Remote Service Unavailable tags: - Partner Whitelisting description: Whitelist a trusted Partner. delete: summary: Remove Partner from Whitelist tags: - Partner Whitelisting responses: '204': description: No Content '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Not Found: value: error: errors: - type: error code: entity_not_found message: Partner not found for id 'string' code: 404 message: Not Found '503': description: Service Unavailable content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Fraud Detection Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable API Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'API' is currently unavailable code: 503 message: Remote Service Unavailable description: Remove a partner from the whitelist operationId: delete-whitelisted-partner /v2/campaigns/{campaign_id}/fraud/incidents/{incident_id}/reject-conversions: parameters: - schema: type: string name: campaign_id in: path required: true description: Campaign ID - schema: type: string name: incident_id in: path required: true description: Incident ID post: summary: Reject Fraudulent Conversions tags: - Incidents responses: '204': description: No Content '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Not Found: value: error: errors: - type: error code: entity_not_found message: Incident not found for id 'string' code: 404 message: Not Found '503': description: Service Unavailable content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Fraud Detection Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable API Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'API' is currently unavailable code: 503 message: Remote Service Unavailable operationId: fraud-reject-conversions description: Reject fraudulent conversions for the Incident /v2/campaigns/{campaign_id}/fraud/incidents/{incident_id}/pend-conversions: parameters: - schema: type: string name: campaign_id in: path required: true description: Campaign ID - schema: type: string name: incident_id in: path required: true description: Incident ID post: summary: Set Incident Conversion status to Pending tags: - Incidents responses: '204': description: No Content '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Not Found: value: error: errors: - type: error code: entity_not_found message: Incident not found for id 'string' code: 404 message: Not Found '503': description: Service Unavailable content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Fraud Detection Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable API Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'API' is currently unavailable code: 503 message: Remote Service Unavailable operationId: fraud-pend-conversions description: Set Incident Conversion status to Pending /v2/campaigns/{campaign_id}/fraud/incident-partners: parameters: - name: campaign_id in: path description: Campaign ID required: true schema: type: string get: summary: List Incident-partners tags: - Incidents parameters: - name: metric in: query description: 'Filter the query by incident `metric`. This parameter must be used in conjunction with `type`. ' required: false schema: type: string enum: - volume_clicks - volume_conversions - conversion_ratio - basket_variability_sku - conversion_value - ttc - name: type in: query description: 'Filter the query by incident `type`. This parameter must be used in conjunction with `metric`. ' required: false schema: type: string enum: - partner - conversion - name: status in: query description: Filter the query by incident `status`. required: false schema: type: string enum: - active - deleted - name: start_date in: query description: Only consider incidents after this date. required: false schema: type: string format: date - name: end_date in: query description: Only consider incidents before this date. required: false schema: type: string format: date responses: '200': description: OK content: application/json: schema: $schema: http://json-schema.org/draft-07/schema type: object title: GET incident-partners Response description: This is the response to a GET incident-partners call on the PzAPI. required: - incident-partners properties: incident-partners: type: array additionalItems: false items: type: object required: - partner_id - partner_name properties: partner_id: type: string partner_name: type: string additionalProperties: false additionalProperties: false '400': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Bad Status: value: error: errors: - type: error code: invalid_status message: No status with the name `status` was found code: 400 message: Bad Request Bad Metric: value: error: errors: - type: error code: invalid_metric message: No metric with the name `metric` was found code: 400 message: Bad Request Bad Metric Type: value: error: errors: - type: error code: invalid_metric_type message: No metric type of `metric_type` was found code: 400 message: Bad Request Bad Request: value: error: errors: - type: error code: invalid_params message: If you specify a metric filter, you must also specify type code: 400 message: Bad Request '403': description: Unauthorised content: application/json: schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' examples: Unauthorised: value: error: errors: - type: error code: unauthorised message: Feature 'fraud_detection' not enabled for this Network code: 403 message: Forbidden '503': description: Fraud Service Unavailable content: application/json: examples: Fraud Service Unavailable: value: error: errors: - type: error code: remote_service_unavailable message: The remote service 'Fraud Detection' is currently unavailable code: 503 message: Remote Service Unavailable schema: $ref: '#/paths/~1v2~1networks~1%7Bnetwork_id%7D~1publishers/get/responses/400/content/application~1json/schema' description: Get a list of all partners that are associated with incidents. operationId: get-incident-partners /report/campaign_group/{campaign_group_id}/filter_sets/{filter_set_id}: delete: parameters: - description: Id of the campaign group example: '7' in: path name: campaign_group_id required: true schema: type: string - description: Id of the Saved Report example: '38' in: path name: filter_set_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: count: 1 errors: [] execution_time: 0.23640 seconds filter_sets: - filter_set: campaign_id: 42C32 created_at: '2016-03-10T19:02:35Z' created_by: 31v02 data: '' is_default: false name: My saved report reporting_filter_set_id: gh51kn updated_at: '2016-03-15T15:38:11Z' updated_by: 68i34 user_id: 53vc3a schema: properties: count: description: Number of Saved Reports deleted type: number errors: description: Empty error list execution_time: type: string filter_sets: description: Deleted Saved Reports list items: $ref: '#/components/schemas/Brand_Filter_Set' type: array type: object description: OK tags: - Filter Sets description: '' operationId: Delete Campaign Group Saved Report summary: Delete a Campaign Group Saved Report get: parameters: - description: Id of the campaign group example: '7' in: path name: campaign_group_id required: true schema: type: string - description: Id of the Saved Report example: '38' in: path name: filter_set_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: count: 1 execution_time: 0.23640 seconds filter_sets: - filter_set: campaign_id: 42C32 created_at: '2016-03-10T19:02:35Z' created_by: 31v02 data: '' is_default: false name: My filter set reporting_filter_set_id: gh51kn updated_at: '2016-03-15T15:38:11Z' updated_by: 68i34 user_id: 53vc3a schema: properties: count: type: number execution_time: type: string filter_sets: items: $ref: '#/components/schemas/Brand_Filter_Set' type: array type: object description: OK tags: - Saved Reports description: Retrieve a Campaign Group Saved Report by id operationId: Retrieve Campaign Group Saved Report summary: Retrieve a Campaign Group Saved Report put: parameters: - description: Id of the campaign group example: '7' in: path name: campaign_group_id required: true schema: type: string - description: Id of the Saved Report example: '38' in: path name: filter_set_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: count: 1 errors: [] execution_time: 0.23640 seconds filter_sets: - filter_set: campaign_id: 42C32 created_at: '2016-03-10T19:02:35Z' created_by: 31v02 data: '' is_default: false name: My filter set reporting_filter_set_id: gh51kn updated_at: '2016-03-15T15:38:11Z' updated_by: 68i34 user_id: 53vc3a schema: properties: count: type: number execution_time: type: string filter_sets: items: $ref: '#/components/schemas/Filter_Set_Body' type: array type: object description: OK tags: - Saved Reports description: Update a Campaign Group Saved Report by id operationId: Update Campaign Group Saved Report requestBody: content: application/json: schema: example: is_default: false name: My new name properties: data: description: Must be a valid JSON string type: string is_default: type: boolean name: type: string type: object summary: Update a Campaign Group Saved Report /v3/brand/analytics/clicks/count: post: summary: Count description: 'Returns aggregated metrics derived from clicks. This endpoint is ideal for creating dashboard widgets, or for creating a summary of tabulated data from the explode endpoint. ' operationId: postClicksCount tags: - Clicks requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics properties: date_time_ranges: allOf: - type: array items: type: object required: - start - end properties: start: type: string format: date-time end: type: string format: date-time field: type: string description: The date-time field that this date-time range should use additionalProperties: false minItems: 1 description: Filter the results to given date-time ranges. You can specify multiple date ranges and results for each date range will be combined. - items: properties: field: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/interval/properties/field' comparison_date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: description: Filter data by specified campaign identifiers. You must have the correct authorisation to view reporting data on these campaigns. type: object required: - campaigns properties: campaigns: type: array items: type: string minItems: 1 uniqueItems: true additionalProperties: false metrics: allOf: - type: array minItems: 1 uniqueItems: true description: Array of metrics which should be included in the result. - items: type: string enum: - total_clicks - total_clicks_converted - click_conversion_rate - total_unique_clicks filter_by: allOf: - type: array description: A list of objects you can use to filter the results by. Results will only be returned if they match every condition. items: type: object required: - field - value properties: field: type: string value: type: - string - integer - array operator: type: string default: EQUALS not: type: boolean additionalProperties: false minItems: 1 - items: properties: field: type: string enum: - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign_id - campaign_name - country - creative_id - creative_description - creative_advertiser_reference - creative_tag_id - device_id - os_family - os_major - os_minor - os_patch - partner_group_id - partner_id - partner_name - partnership_model_id - traffic_source_id - type - user_context_id operator: type: string enum: - EQUALS - STARTS_WITH - ENDS_WITH - CONTAINS - SEARCH timezone: description: See reference endpoint [/reference/timezones/](/#tag/Timezones) for available timezones. type: string include_comparison_percentage_change: type: boolean default: false description: A boolean flag to indicate whether percentage changes should be output when using comparison. additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_clicks filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: object example: total_clicks: 57126 /v3/brand/analytics/clicks/explode: post: summary: Explode description: 'Returns aggregated metrics derived from clicks, grouped by ID and name of one or many dimensions. This endpoint is ideal for fetching data to be shown in a table. You can combine it with the count endpoint to fetch data for a totals row. If `order_by` is requested on a metric, the metric values will be added to the results, even if not requested. When grouping by `date`, the `interval` will define the length of each date group. ' operationId: postClicksExplode tags: - Clicks requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics - group_by properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' comparison_date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/metrics' group_by: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/group_by' filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by' order_by: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/order_by' interval: allOf: - description: To group the data into buckets of time. In the context of Explode this is used when grouping by `date_time` type: object required: - period properties: period: type: string pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d+[HMS])(\d+H)?(\d+M)?(\d+S)?)?$ description: ISO8601 time interval value. default: P1D field: type: string description: The date-time field that should be used to group each date interval additionalProperties: false properties: field: type: string enum: - date_time output_date_time_format: type: string description: Dates will be formatted with the Joda date format string given. If no format is supplied here, ISO8601 format will be used. For details of how to construct a format string, see https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html top: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top' include_total_row_count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' include_comparison_percentage_change: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/include_comparison_percentage_change' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_clicks group_by: - device filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true order_by: - field: total_clicks direction: DESCENDING interval: field: date_time period: P1D include_total_row_count: false timezone: GMT top: 2 responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - device_id: '1' device_name: desktop total_clicks: 2000 - device_id: '2' device_name: mobile total_clicks: 3000 headers: X-Total-Row-Count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count' /v3/brand/analytics/clicks/filter: post: summary: Filter description: 'This endpoint is ideal for fetching a list of available dimensions for a dropdown list. If `order_by` is requested on a metric, the metric values will be added to the results. ' operationId: postClicksFilter tags: - Clicks requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - group_by properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' group_by: allOf: - type: array minItems: 1 uniqueItems: true description: Dimensions which the data should be grouped by. - items: type: string enum: - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign - country - creative - date_time - device - os_family - os_major - os_minor - os_patch - partner - partnership_model - traffic_source - type - user_context filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by' order_by: allOf: - type: array description: Priority list of ordering objects items: type: object required: - field - direction properties: field: type: string direction: type: string enum: - ASCENDING - DESCENDING additionalProperties: false minItems: 1 - items: properties: field: type: string enum: - total_clicks - total_clicks_converted - click_conversion_rate - total_unique_clicks - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign_id - campaign_name - country - country_name - creative_id - creative_description - creative_advertiser_reference - date_time - device_id - device_name - os_family - os_major - os_minor - os_patch - partner_id - partner_name - partnership_model_id - partnership_model_name - traffic_source_id - traffic_source_name - type - user_context_id - user_context_name top: type: integer maximum: 50000 default: 50000 minimum: 1 include_total_row_count: type: boolean default: false description: A boolean flag to indicate whether an extra header (X-Total-Row-Count) should be returned containing the total number of rows. This can have a performance overhead so you should not use it unless it is required. timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 group_by: - device filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true order_by: - field: total_clicks direction: DESCENDING top: 2 include_total_row_count: false timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - device_id: '1' device_name: desktop total_clicks: 44442 - device_id: '2' device_name: mobile total_clicks: 23392 headers: X-Total-Row-Count: schema: type: integer description: Total amount of rows, ignoring `top`. Present if requested via `include_total_row_count`. /v3/brand/analytics/clicks/timeseries: post: summary: Timeseries description: 'Returns aggregated metrics derived from clicks, grouped by time intervals. This endpoint is ideal for creating charts where the x-axis is time. ' operationId: postClicksTimeseries tags: - Clicks requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/metrics' filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by' interval: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/interval' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' zerofill: type: boolean default: true description: A boolean flag to indicate whether records with a count of zero should be included in the response. additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_clicks filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true interval: field: date_time period: P1D timezone: GMT zerofill: false responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - date_time_range: start: '2019-10-01T00:00:00+00:00' end: '2019-10-02T00:00:00+00:00' total_clicks: 990 - date_time_range: start: '2019-10-02T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' total_clicks: 2894 /v3/brand/analytics/conversions/count: post: summary: Count description: 'Returns aggregated metrics derived from conversions. This endpoint is ideal for creating dashboard widgets, or for creating a summary of tabulated data from the explode endpoint. ' operationId: postConversionsCount tags: - Conversions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics properties: date_time_ranges: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges/allOf/0' - items: properties: field: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1explode/post/requestBody/content/application~1json/schema/properties/interval/properties/field' comparison_date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/metrics/allOf/0' - items: type: string enum: - total_conversion_items - total_conversions - total_commission - average_commission - percentage_commission - total_partner_commission - percentage_partner_commission - average_partner_commission - percentage_average_partner_commission - average_order_value - percentage_order_value - total_order_value - e_cpa - conversion_rejection_rate - total_roas - average_roas - average_order_size filter_by: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by/allOf/0' - items: properties: field: type: string enum: - commission - partner_commission - order_value - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign_id - campaign_name - category - conversion_metric_id - conversion_reference - conversion_status - conversion_type_id - country - creative_id - creative_description - creative_advertiser_reference - creative_tag_id - currency - customer_reference - customer_type - device_id - os_family - os_major - os_minor - os_patch - partner_group_id - partner_id - partner_name - partnership_model_id - sku - traffic_source_id - type - user_context_id - voucher_code - voucher_status operator: description: 'String fields can be filtered with: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `SEARCH`. Numeric fields can be filtered with `EQUALS`, `GREATER_THAN`, `GREATER_THAN_OR_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUALS`.' if: properties: field: type: string enum: - commission - partner_commission - order_value then: properties: operator: type: string enum: - EQUALS - GREATER_THAN - GREATER_THAN_OR_EQUALS - LESS_THAN - LESS_THAN_OR_EQUALS else: properties: operator: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by/allOf/1/items/properties/operator' output_currency: description: Currency based metrics will be converted into this currency. This also applies to filter values. See reference endpoint [/reference/currencies/](/#tag/Currencies) for available currencies. type: string default: USD timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' include_comparison_percentage_change: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/include_comparison_percentage_change' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_commission filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true output_currency: GBP timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: object example: total_conversions: 12 headers: X-Approximate-Metrics: schema: type: string example: total_unique_clicks description: 'Comma-separated list of metrics that are approximates. The metric does not have to be part of the current request. Present if conditions for approximation are met, and at least one metric on the context is an approximate. ' /v3/brand/analytics/conversions/explode: post: summary: Explode description: 'Returns aggregated metrics derived from conversions, grouped by ID and name of one or many dimensions. This endpoint is ideal for fetching data to be shown in a table. You can combine it with the count endpoint to fetch data for a totals row. If `order_by` is requested on a metric, the metric values will be added to the results, even if not requested. When grouping by `date`, the `interval` will define the length of each date group. ' operationId: postConversionsExplode tags: - Conversions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics - group_by properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' comparison_date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/metrics' group_by: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1filter/post/requestBody/content/application~1json/schema/properties/group_by' filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/filter_by' order_by: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1filter/post/requestBody/content/application~1json/schema/properties/order_by' interval: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/interval/allOf/0' properties: field: type: string enum: - date_time - approved_at - check_in_date - check_out_date output_currency: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/output_currency' output_date_time_format: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/output_date_time_format' top: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top' include_total_row_count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' include_comparison_percentage_change: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/include_comparison_percentage_change' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_commission group_by: - partner filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true order_by: - field: total_commission direction: DESCENDING interval: field: date_time period: P1D output_currency: USD top: 2 include_total_row_count: false timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - device_id: '1' device_name: desktop total_conversions: 2000 - device_id: '2' device_name: mobile total_conversions: 3000 headers: X-Total-Row-Count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count' X-Approximate-Metrics: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/responses/200/headers/X-Approximate-Metrics' /v3/brand/analytics/conversions/filter: post: summary: Filter description: 'This endpoint is ideal for fetching a list of available dimensions for a dropdown list. If `order_by` is requested on a metric, the metric values will be added to the results. ' operationId: postConversionsFilter tags: - Conversions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - group_by properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' group_by: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/group_by/allOf/0' - items: type: string enum: - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign - category - conversion_metric - conversion_reference - conversion_status - conversion_type - country - creative - currency - customer_reference - customer_type - date_time - device - os_family - os_major - os_minor - os_patch - partner - partnership_model - sku - traffic_source - type - user_context - voucher_code - voucher_status filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/filter_by' order_by: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/order_by/allOf/0' - items: properties: field: type: string enum: - total_conversion_items - total_conversions - total_commission - total_partner_commission - total_order_value - average_order_value - percentage_average_partner_commission - e_cpa - conversion_rejection_rate - total_roas - average_roas - average_order_size - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign_id - campaign_name - category - conversion_metric_id - conversion_metric_name - conversion_reference - conversion_status - conversion_type_id - conversion_type_name - country - country_name - creative_id - creative_description - creative_advertiser_reference - currency - customer_reference - customer_type - date_time - device_id - device_name - os_family - os_major - os_minor - os_patch - partner_id - partner_name - partnership_model_id - partnership_model_name - sku - traffic_source_id - traffic_source_name - type - user_context_id - user_context_name - voucher_code - voucher_status output_currency: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/output_currency' top: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top' include_total_row_count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 group_by: - partner filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true order_by: - field: total_commission direction: DESCENDING interval: field: date_time period: P1D output_currency: USD top: 10 include_total_row_count: false timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - device_id: '1' device_name: desktop total_conversions: 44442 - device_id: '2' device_name: mobile total_conversions: 23392 headers: X-Total-Row-Count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count' X-Approximate-Metrics: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/responses/200/headers/X-Approximate-Metrics' /v3/brand/analytics/conversions/timeseries: post: summary: Timeseries description: 'Returns aggregated metrics derived from conversions, grouped by time intervals. This endpoint is ideal for creating charts where the x-axis is time. ' operationId: postConversionsTimeseries tags: - Conversions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/metrics' filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/filter_by' interval: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1explode/post/requestBody/content/application~1json/schema/properties/interval' output_currency: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/output_currency' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' zerofill: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1timeseries/post/requestBody/content/application~1json/schema/properties/zerofill' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_commission filter_by: - field: country value: US operator: EQUALS - field: device_id value: 5 operator: EQUALS not: true interval: field: date_time period: P1D output_currency: GBP timezone: GMT zerofill: false responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - date_time_range: start: '2019-10-01T00:00:00+00:00' end: '2019-10-02T00:00:00+00:00' total_conversions: 990 - date_time_range: start: '2019-10-02T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' total_conversions: 2894 headers: X-Approximate-Metrics: $ref: '#/paths/~1v3~1brand~1analytics~1conversions~1count/post/responses/200/headers/X-Approximate-Metrics' /v3/brand/analytics/impressions/count: post: summary: Count description: 'Returns aggregated metrics derived from impressions. This endpoint is ideal for creating dashboard widgets, or for creating a summary of tabulated data from the explode endpoint. ' operationId: postImpressionsCount tags: - Impressions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics properties: date_time_ranges: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges/allOf/0' - items: properties: field: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1explode/post/requestBody/content/application~1json/schema/properties/interval/properties/field' comparison_date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/metrics/allOf/0' - items: type: string enum: - total_impressions filter_by: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by/allOf/0' - items: properties: field: type: string enum: - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign_id - campaign_name - country - creative_id - creative_description - creative_advertiser_reference - creative_tag_id - device_id - os_family - os_major - os_minor - os_patch - partner_group_id - partner_id - partner_name - partnership_model_id - traffic_source_id - user_context_id operator: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by/allOf/1/items/properties/operator' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' include_comparison_percentage_change: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/include_comparison_percentage_change' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_impressions filter_by: - field: device_id value: 5 operator: EQUALS not: true timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: object example: total_impressions: 57126 /v3/brand/analytics/impressions/explode: post: summary: Explode description: 'Returns aggregated metrics derived from impressions, grouped by ID and name of one or many dimensions. This endpoint is ideal for fetching data to be shown in a table. You can combine it with the count endpoint to fetch data for a totals row. If `order_by` is requested on a metric, the metric values will be added to the results, even if not requested. When grouping by `date`, the `interval` will define the length of each date group. ' operationId: postImpressionsExplode tags: - Impressions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics - group_by properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' comparison_date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/metrics' group_by: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1filter/post/requestBody/content/application~1json/schema/properties/group_by' filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/filter_by' order_by: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1filter/post/requestBody/content/application~1json/schema/properties/order_by' interval: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/interval/allOf/0' properties: field: type: string enum: - date_time output_date_time_format: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/output_date_time_format' top: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top' include_total_row_count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' include_comparison_percentage_change: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/include_comparison_percentage_change' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_impressions group_by: - partner filter_by: - field: device_id value: 5 operator: EQUALS order_by: - field: total_impressions direction: DESCENDING interval: field: date_time period: P1D top: 10 include_total_row_count: false timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - device_id: '1' device_name: desktop total_impressions: 2000 - device_id: '2' device_name: mobile headers: X-Total-Row-Count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count' /v3/brand/analytics/impressions/filter: post: summary: Filter description: 'This endpoint is ideal for fetching a list of available dimensions for a dropdown list. If `order_by` is requested on a metric, the metric values will be added to the results. ' operationId: postImpressionsFilter tags: - Impressions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - group_by properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' group_by: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/group_by/allOf/0' - items: type: string enum: - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign - country - creative - date_time - device - os_family - os_major - os_minor - os_patch - partner - partnership_model - traffic_source - user_context filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/filter_by' order_by: allOf: - $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/order_by/allOf/0' - items: properties: field: type: string enum: - total_impressions - advertiser_reference - browser_family - browser_major - browser_minor - browser_patch - campaign_id - campaign_name - country - creative_id - creative_description - creative_advertiser_reference - date_time - device_id - device_name - os_family - os_major - os_minor - os_patch - partner_id - partner_name - partnership_model_id - partnership_model_name - traffic_source_id - traffic_source_name - user_context_id - user_context_name top: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top' include_total_row_count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 group_by: - partner filter_by: - field: device_id value: 5 operator: EQUALS order_by: - field: total_impressions direction: DESCENDING top: 10 include_total_row_count: false timezone: GMT responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - device_id: '1' device_name: desktop total_impressions: 44442 - device_id: '2' device_name: mobile total_impressions: 23392 headers: X-Total-Row-Count: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count' /v3/brand/analytics/impressions/timeseries: post: summary: Timeseries description: 'Returns aggregated metrics derived from impressions, grouped by time intervals. This endpoint is ideal for creating charts where the x-axis is time. ' operationId: postImpressionsTimeseries tags: - Impressions requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object required: - date_time_ranges - scope - metrics properties: date_time_ranges: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges' scope: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope' metrics: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/metrics' filter_by: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/filter_by' interval: $ref: '#/paths/~1v3~1brand~1analytics~1impressions~1explode/post/requestBody/content/application~1json/schema/properties/interval' timezone: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone' zerofill: $ref: '#/paths/~1v3~1brand~1analytics~1clicks~1timeseries/post/requestBody/content/application~1json/schema/properties/zerofill' additionalProperties: false example: date_time_ranges: - start: '2019-10-01T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' scope: campaigns: - 111111l10 metrics: - total_impressions filter_by: - field: device_id value: 5 operator: EQUALS interval: field: date_time period: P1D timezone: GMT zerofill: false responses: '200': description: Successful operation content: application/json: schema: type: object required: - data properties: data: type: array example: - date_time_range: start: '2019-10-01T00:00:00+00:00' end: '2019-10-02T00:00:00+00:00' total_impressions: 990 - date_time_range: start: '2019-10-02T00:00:00+00:00' end: '2019-10-03T00:00:00+00:00' total_impressions: 2894 /v3/brand/campaign-groups/{campaign_group_id}/campaigns: get: parameters: - description: Id of the campaign group example: 7 name: campaign_group_id required: true in: path schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: data: - campaign_id: 111111l6 title: campaign_title schema: properties: data: type: array items: type: object properties: campaign_name: type: string title: type: string description: OK tags: - Campaign Group Campaigns description: Retrieve a List of Campaigns in a Campaign Group by id operationId: Retrieve a List of Campaigns in a Campaign Group summary: Retrieve a List of Campaigns in a Campaign Group /v3/brand/campaigns: get: summary: List campaigns operationId: listCampaigns description: Return a list of campaigns of the logged-in user's brand tags: - Campaign v3 parameters: - name: brand_id in: query description: Brand ID to filter campaigns by schema: type: string responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Campaign list response properties: data: type: array items: $ref: '#/paths/~1v3~1brand~1campaigns~1%7BcampaignId%7D/get/responses/200/content/application~1json/schema/properties/data' /v3/brand/campaigns/{campaignId}: get: summary: Get campaign operationId: getCampaign description: Return information about a single campaign from the provided ID. tags: - Campaign v3 parameters: - name: campaignId in: path description: The ID of the Partnerize campaign to be returned required: true schema: type: string - name: extra_info in: query description: Comma-separated list of extra_info to fetch; defaults to none; supply `*` to fetch all; unknown values will be ignored schema: type: string example: allow_deep_linking,campaign_logo responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Campaign response properties: data: $schema: http://json-schema.org/draft-07/schema# type: object title: Campaign properties: id: type: string description: Unique identifier of a Campaign examples: - 10l176 title: type: string description: Human readable title of a Campaign examples: - PHG Aff Demo brand: type: object description: This Campaign's brand properties: id: type: string description: Unique identifier of a Brand examples: - 10l110 name: type: string description: Human readable name of a Brand examples: - PHG Aff display_name: type: - string - 'null' description: Human readable display name of a Brand examples: - PHG Affiliations extra_info: type: object description: Requested extra_info if any, otherwise this key is missing additionalProperties: type: string examples: - shopify_shop_id: 123abc patch: summary: Partial campaign update operationId: partialUpdateCampaign description: Update some information of a campaign. tags: - Campaign v3 parameters: - name: campaignId in: path description: The ID of the Partnerize campaign to be returned required: true schema: type: string requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Partial Update request properties: extra_info: type: object description: Any campaign extra_info to update. Key must be a supported extra_info. additionalProperties: type: string examples: - shopify_shop_id: 123abc responses: '204': description: Success /v3/brand/partnerize-tags: get: summary: List Partnerize Tags operationId: listPartnerizeTags description: Return a list of available Partnerize Tags. tags: - Partnerize Tags parameters: - description: ID of the brand to restrict scope of Partnerize Tags to example: 111111l3 in: query name: brand_id required: false schema: type: string - description: Optional flag to include features as part of the response example: true in: query name: with_features required: false schema: type: boolean responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Partnerize Tags list properties: data: type: array description: List of Partnerize Tags for Brand items: $schema: http://json-schema.org/draft-07/schema# type: object description: Partnerize Tag data properties: id: type: string description: Unique identifier of a Partnerize Tag scope: type: object properties: brand: type: string description: Brand ID for the Partnerize Tag name: type: string description: Human readable identifier of a Partnerize Tag active: type: boolean description: If the tag is not active, the feature content will not be generated for the tag created_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' created_by: type: string last_modified_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at' last_modified_by: type: string url: type: string description: The publicly accessible URL for the Partnerize Tag for embedding into website content example: data: - id: 111111l35 scope: brand: 111111l2 name: my-tag-website active: true created_at: '2020-07-22T12:23:58.000Z' created_by: 111111l1 last_modified_at: '2020-07-22T12:23:58.000Z' last_modified_by: 111111l1 url: https://pzapi-kg.com/b/1100l12/1011l1.js - id: 111111l36 scope: brand: 111111l2 name: my-tag-mobile active: true created_at: '2020-08-08T12:23:58.000Z' created_by: 111111l1 last_modified_at: '2020-08-08T12:23:58.000Z' last_modified_by: 111111l1 url: https://pzapi-kg.com/b/1100l12/1011l1.js post: summary: Create Partnerize Tag operationId: createPartnerizeTag description: Generates a new Partnerize Tag for the requested brand. Freshly generated tag will be empty, without any features enabled by default.

To allow for global propagation, tags will typically be available for use 15 minutes after their generation. tags: - Partnerize Tags requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Partnerize Tag Request description: Partnerize Tag Creation Request required: - name - scope properties: name: type: string description: A name for the new Partnerize Tag minLength: 1 maxLength: 255 scope: type: object properties: brand: type: string description: Brand ID for the Partnerize Tag responses: '201': content: application/json; charset=utf-8: examples: response: value: data: id: 111111l35 scope: brand: 111111l2 name: my-tag-website active: true created_at: '2020-07-22T12:23:58.000Z' created_by: 111111l1 last_modified_at: '2020-07-22T12:23:58.000Z' last_modified_by: 111111l1 url: https://pzapi-kg.com/b/1100l12/1011l1.js schema: $schema: http://json-schema.org/draft-07/schema# type: object description: Partnerize Tag data properties: data: type: object $ref: '#/paths/~1v3~1brand~1partnerize-tags/get/responses/200/content/application~1json/schema/properties/data/items' description: OK /v3/brand/partnerize-tags/{partnerizeTagId}: get: summary: Get Partnerize Tag operationId: getPartnerizeTag description: Return information about a single Partnerize Tag from the provided ID. tags: - Partnerize Tags parameters: - name: partnerizeTagId in: path description: The ID of the Partnerize Tag to be returned required: true schema: type: string responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Partnerize Tag single data properties: data: type: object $ref: '#/paths/~1v3~1brand~1partnerize-tags/get/responses/200/content/application~1json/schema/properties/data/items' example: data: id: 111111l35 scope: brand: 111111l2 name: my-tag-website active: true created_at: '2020-07-22T12:23:58.000Z' created_by: 111111l1 last_modified_at: '2020-07-22T12:23:58.000Z' last_modified_by: 111111l1 url: https://pzapi-kg.com/b/1100l12/1011l1.js patch: summary: Update Partnerize Tag operationId: updatePartnerizeTag description: Updates a specific Partnerize Tag. tags: - Partnerize Tags parameters: - name: partnerizeTagId in: path description: The ID of the Partnerize Tag to be updated required: true schema: type: string requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Partnerize Tag Request description: Partnerize Tag Patch Request properties: name: type: string description: A new name for the Partnerize Tag minLength: 1 maxLength: 255 active: type: boolean description: Enables/Disables the tag responses: '200': content: application/json; charset=utf-8: examples: response: value: data: id: 111111l35 scope: brand: 111111l2 name: my-tag-website active: true created_at: '2020-07-22T12:23:58.000Z' created_by: 111111l1 last_modified_at: '2020-07-22T12:23:58.000Z' last_modified_by: 111111l1 url: https://pzapi-kg.com/b/1100l12/1011l1.js schema: $schema: http://json-schema.org/draft-07/schema# type: object description: Partnerize Tag data properties: data: type: object $ref: '#/paths/~1v3~1brand~1partnerize-tags/get/responses/200/content/application~1json/schema/properties/data/items' description: OK delete: summary: Delete Partnerize Tag operationId: deletePartnerizeTag description: Deletes a specific Partnerize Tag. tags: - Partnerize Tags parameters: - name: partnerizeTagId in: path description: The ID of the Partnerize Tag to be deleted required: true schema: type: string responses: '204': description: The Partnerize Tag was deleted successfully. /v3/brand/partnerize-tags/features: get: summary: List Available Partnerize Tag Features operationId: listPartnerizeTagFeatures description: Returns a list of available features ready for enablement in a Partnerize Tag. tags: - Partnerize Tag Features responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object description: List Feature Response properties: data: type: array items: $schema: http://json-schema.org/draft-07/schema# type: object title: Partnerize Tag Feature object properties: name: type: string description: type: string config_schema: type: array example: 'name:': tracking-link-generation 'description:': Tracking link generation from standard brand URLs config_schema: [] /v3/brand/partnerize-tags/{tagId}/features: get: summary: List Partnerize Tag Enabled Features operationId: listPartnerizeTagEnabledFeatures description: Return a list of features enabled for a specific Partnerize Tag. tags: - Partnerize Tag Features parameters: - name: tagId in: path description: The ID of the Partnerize Tag required: true schema: type: string responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object description: List Feature Response properties: data: type: array items: $schema: http://json-schema.org/draft-07/schema# type: object title: Partnerize Tag Feature object properties: name: type: string description: type: string config: type: object example: 'name:': first-party-tracking 'description:': Cookie-less conversion pixel integration config: null example: data: - 'name:': first-party-tracking 'description:': Cookie-less conversion pixel integration config: null post: summary: Enable Feature on Partnerize Tag operationId: enablePartnerizeTagFeature description: Enables a feature for a specific Partnerize Tag. tags: - Partnerize Tag Features parameters: - name: tagId in: path description: The ID of the Partnerize Tag required: true schema: type: string requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Partnerize Tag Request description: Partnerize Tag Feature Addition required: - name properties: name: type: string description: Feature name which will be added to the Partnerize Tag config: type: object description: Additional feature config, if needed example: name: first-party-tracking examples: First Party Tracking: value: name: first-party-tracking config: null Revlifter Tag: value: name: revlifter config: uuid: 5ad7ef40-a4bd-4d34-b522-1eee9e127dc6 Upsellit Tag: value: name: upsellit config: usi_launch_tag: partnerize Intently Tag: value: name: intent.ly config: domain: test.com responses: '201': content: application/json; charset=utf-8: examples: First Party Tracking: value: data: name: first-party-tracking config: null Revlifter Tag: value: data: name: revlifter config: uuid: 5ad7ef40-a4bd-4d34-b522-1eee9e127dc6 Upsellit Tag: value: data: name: upsellit config: usi_launch_tag: partnerize schema: $schema: http://json-schema.org/draft-07/schema# type: object description: Add Feature Response properties: data: type: object properties: name: type: string description: Feature name config: type: object description: Feature configuration description: OK /v3/brand/partnerize-tags/{tagId}/features/{featureName}: delete: summary: Disable Feature on Partnerize Tag operationId: disablePartnerizeTagFeature description: Disables a feature for a specific Partnerize Tag. tags: - Partnerize Tag Features parameters: - name: tagId in: path description: The ID of the Partnerize Tag required: true schema: type: string - name: featureName in: path description: The name of the feature to remove required: true schema: type: string responses: '204': description: The Partnerize Tag Feature was removed successfully. /v3/brand/network-terms-and-conditions: get: summary: List network terms and conditions description: Lists all network terms and conditions that must be accepted by a brand tags: - Network Terms and Conditions (v3) parameters: - name: network_id in: query description: Filter by a network required: true schema: type: string example: 1111l11 - name: types in: query description: Filter by terms and conditions types schema: type: string, enum: - partner_recruitment - name: locale in: query description: Filter by locale. schema: $ref: '#/components/schemas/Locale' responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object properties: data: type: array items: $schema: http://json-schema.org/draft-07/schema# type: object properties: id: type: string example: '10' terms_locale_id: type: string example: 1010l00 content: type: string example:

Please agree to the following terms:

locale: $ref: '#/components/schemas/Locale' created_at: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at/definitions/date-time' /v3/brand/network-terms-and-conditions-acknowledgments: post: summary: Create network terms and conditions acknowledgment description: Create an acknowledgement for network terms and conditions tags: - Network Terms and Conditions Acknowledgments (v3) requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object properties: network_id: type: string example: 0000l00 terms_locale_id: type: string example: 1010l00 required: - network_id - terms_locale_id responses: '201': description: Created /v3/network/{networkId}/commission-groups: get: summary: List commission groups description: Lists all network commission groups tags: - Commission Groups parameters: - name: network_id in: query description: Filter by a network required: true schema: type: string example: 1111l11 - name: active in: query description: Whether the commission groups are still ongoing schema: type: boolean, default: true - name: has_participation in: query description: Only return commission groups that have partners participating schema: type: boolean responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object properties: data: type: array items: $schema: http://json-schema.org/draft-07/schema# type: object properties: id: type: string example: 1111l11 name: type: string example: My Commission Group active: type: boolean start_date: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at/definitions/date-time' end_date: $ref: '#/paths/~1v3~1jobs~1%7BjobID%7D/get/responses/200/content/application~1json/schema/properties/data/properties/created_at/definitions/date-time' campaign: type: object properties: id: type: string example: 1111l11 name: type: string example: Campaign A /v3/network/{networkId}/brands: get: summary: Get brands for a network description: Lists brands for a given network tags: - Brands parameters: - name: networkId in: path description: Network ID to get brands for schema: type: string example: 1111l11 - name: with in: query description: Extra data to fetch as a comma seperated list. Currently only accepts "deeplink-domains" schema: type: string example: deeplink-domains responses: '200': description: Request Success content: application/json: schema: $ref: '#/paths/~1v3~1brand/get/responses/200/content/application~1json/schema' /v3/brand: get: summary: Get brands for a user description: Lists brands the user has access to tags: - Brands parameters: - name: network_id in: query description: A way to filter brands by network schema: type: string example: 1111l11 - name: with in: query description: Extra data to fetch as a comma seperated list. Currently only accepts "deeplink-domains" schema: type: string example: deeplink-domains responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: v3 Brand list response examples: - data: - brand_id: 111111l1 brand_name: Brand One - brand_id: 111111l2 brand_name: Brand Two - data: - brand_id: 111111l1 brand_name: Brand One deeplink-domains: - domain: onebrand.com brand_id: 111111l1 created_by: 111111l1 created_at: '2024-07-25T15:10:03+00:00' - domain: shop.onebrand.com brand_id: 111111l1 created_by: 111111l1 created_at: '2024-07-25T15:10:03+00:00' /v3/brand/participations/{participationId}/paid_search_violation: post: summary: Create a paid search violation description: Create a paid search violation time frame for a given participation tags: - Paid Search Violations parameters: - name: participationId in: path description: The ID of the participation that the paid search violation will be applied to required: true schema: type: string example: 1111l11 requestBody: content: application/json: schema: properties: start_date_time: type: string format: date-time example: '2024-10-10T12:01:00+00:00' description: Datetime when the violation time window should start. The field is optional and will default to the current datetime end_date_time: type: string format: date-time nullable: true example: '2025-10-10T12:01:00+00:00' description: Datetime when the violation time window should end. The field is optional and will default 'null'. If this field is 'null' then all commissions for the participation after the 'start_date_time' will not be paid to the partner additionalProperties: false responses: '201': description: Created content: application/json: schema: properties: data: type: object properties: id: type: string example: 111111l1 participation_id: type: string example: 111111l1 start_date_time: type: string format: date-time example: '2024-10-10T12:01:00+00:00' end_date_time: type: string format: date-time nullable: true example: '2025-10-10T12:01:00+00:00' get: summary: List paid search violations description: Get a timeline of paid search violations for a given participation tags: - Paid Search Violations parameters: - name: participationId in: path description: The ID of the participation that the paid search violation is associated with required: true schema: type: string example: 1111l11 responses: '200': description: Request Success content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object properties: data: type: array items: $ref: '#/paths/~1v3~1brand~1participations~1%7BparticipationId%7D~1paid_search_violation/post/responses/201/content/application~1json/schema/properties/data' /v3/brand/participations/{participationId}/paid_search_violation/{paidSearchViolationId}: delete: summary: Delete a paid search violation description: Deletes or ends a paid search violation. If a paid search violation has been started but the end date has not elapsed, then the end date will be updated to the current datetime. If the paid search violation has not been started then the paid search violation will be completely deleted. tags: - Paid Search Violations parameters: - name: participationId in: path description: The ID of the participation that the paid search violation is associated with required: true schema: type: string example: 1111l11 - name: paidSearchViolationId in: path description: The ID of the paid search violation that will be deleted required: true schema: type: string example: 1111l11 responses: '204': description: Delete Successful /v3/brand/user: patch: summary: Update Current user operationId: updateCurrentUser description: Updates a current User data tags: - Current User requestBody: content: application/json: schema: $schema: http://json-schema.org/draft-07/schema# type: object title: Current User update description: Current User Patch Request properties: emailAddress: type: string description: User email value to be updated format: email responses: '200': content: application/json; charset=utf-8: examples: response: value: data: user_id: 111111l63 email_verified: false email: user@test.com schema: $schema: http://json-schema.org/draft-07/schema# type: object description: Current User data properties: data: type: object $schema: http://json-schema.org/draft-07/schema# description: Current User data properties: user_id: type: string description: Unique identifier of a Current User email_verified: type: boolean description: If user emil has been verified email: type: string format: email description: Email address identifier of a Current User description: OK /reference/vertical: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: verticals: - vertical: description: App downloads name: Downloads vertical_id: 1 schema: properties: verticals: items: $ref: '#/components/schemas/Vertical' type: array type: object description: OK tags: - Verticals description: Reference data endpoint which lists all the verticals. operationId: List all Verticals summary: List all Verticals /reference/locale: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: locales: - locale: code: en printable_name: English schema: properties: locales: items: $ref: '#/components/schemas/Reference_Locale' type: array type: object description: OK tags: - Locales description: List all active locales. operationId: List all Locales summary: List all Locales /reference/country: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: countries: - country: area_sq_km: 468 capital: Andorra la Vella continent_iso: EU continent_name: Europe currency_iso: EUR east: '42.656043' fips_code: AN geoname_id: 3041565 iso: AD iso3: AND iso_numeric: '020' languages: ca north: '42.656043' population: 84000 printable_name: Andorra ref_country_id: 1 south: '42.656043' west: '42.656043' zone: Outside EU VAT area schema: properties: countries: items: $ref: '#/components/schemas/Reference_Country' type: array type: object description: OK tags: - Countries description: List all active countries. operationId: List all Countries summary: List all Countries /reference/currency: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: currencies: - currency: currency_id: 51 iso: GBP minor_unit: 2 name: Pound Sterling schema: properties: currencies: items: $ref: '#/components/schemas/Reference_Currency' type: array type: object description: OK tags: - Currencies description: List all the types of currency. operationId: List all Currencies summary: List all Currencies /reference/currency/country: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: - currency_country: currency_iso: AED: country_iso: - GB AUD: country_iso: - AU - CN - HK - LV - US schema: items: $ref: '#/components/schemas/Reference_Currency_Country' type: array description: OK tags: - Currency countries description: List all Country Currency Combinations operationId: List Country Currency Combinations summary: List Country Currency Combinations /reference/us_state: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: us_states: - us_state: code: AZ printable_name: Alabama schema: properties: us_states: items: $ref: '#/components/schemas/US_State' type: array type: object description: OK tags: - US States description: List all US states. operationId: List US States summary: List US States /reference/timezone: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: timezones: - timezone: description: '[GMT-10:00] Pacific/Tahiti' local_time: '' name: Pacific/Tahiti ref_timezone_id: '3' utc_offset: '-36000' schema: properties: timezones: items: $ref: '#/components/schemas/Timezone' type: array type: object description: OK tags: - Timezones description: List all the timezones. operationId: List all Timezones summary: List all Timezones /reference/device: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: devices: - device: ref_device_id: 2 title: Desktop description: Standard desktop web skip_invoice: 0 skip_selfbill: 0 skip_override: 0 key: desktop schema: properties: devices: items: $ref: '#/components/schemas/Device' type: array type: object description: OK tags: - Devices description: List all device types. operationId: List all Devices summary: List all Devices /reference/campaign_extra_field: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: campaign_extra_fields: - campaign_extra_field: campaign_extra_field_id: 102 field_comment: campaign level country setting field_default_value: nil field_name: country schema: properties: campaign_extra_fields: items: $ref: '#/components/schemas/Campaign_Extra_Field' type: array type: object description: OK tags: - Campaign Extra Fields description: List all the types of campaign extra fields. operationId: List all Campaign Extra Fields summary: List all Campaign Extra Fields /reference/user_context: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: user_contexts: - user_context: ref_user_context_id: 1 title: Other description: Other user context skip_invoice: 0 skip_selfbill: 0 skip_override: 0 key: other schema: properties: user_contexts: items: $ref: '#/components/schemas/User_Context' type: array type: object description: OK tags: - User Contexts description: List all User Context types. operationId: List all User Contexts summary: List all User Contexts /reference/traffic_source: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: traffic_sources: - traffic_source: ref_traffic_source_id: 1 title: Other description: Other traffic source skip_invoice: 0 skip_selfbill: 0 skip_override: 0 schema: properties: traffic_sources: items: $ref: '#/components/schemas/Traffic_Source' type: array type: object description: OK tags: - Traffic Sources description: List all available Traffic Source types. operationId: List Traffic Sources summary: List Traffic Sources /reference/website_type: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: website_types: - website_type: description: null name: Blog website_id: '1' schema: properties: website_types: items: $ref: '#/components/schemas/Website_Type' type: array type: object description: OK tags: - Website Types description: List all the website types. operationId: List Website Types summary: List Website Types /reference/promotional_method: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: promotional_methods: - promotional_method: description: Pay per click name: PPC promotional_method_id: 1 schema: properties: promotional_methods: items: $ref: '#/components/schemas/Promotional_Method' type: array type: object description: OK tags: - Promotional Methods description: List all the types of payment methods. operationId: List all Promotional Method summary: List all Promotional Method /reference/conversion_type: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: conversion_types: - conversion_type: available_to_invoice: y available_to_selfbill: y conversion_type: standard conversion_type_id: 1 description: Standard Transaction exclude_from_override_rules: y schema: properties: conversion_types: items: $ref: '#/components/schemas/Conversion_Type' type: array type: object description: OK tags: - Conversion Types description: List all the conversion types. operationId: List Conversion Type summary: List Conversion Type /reference/conversion_metric: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: conversion_metrics: - conversion_metrics: ref_conversion_metric_id: 3 title: App Download description: '' skip_invoice: 0 skip_selfbill: 0 skip_override: 0 schema: properties: website_types: items: $ref: '#/components/schemas/Conversion_Metric' type: array type: object description: OK tags: - Conversion Metrics description: List all available Conversion Metrics. operationId: List Conversion Metrics summary: List Conversion Metrics /reference/partnership_model: get: responses: '200': content: application/json; charset=utf-8: examples: response: value: partnership_models: - partnership_model: ref_partnership_model_id: 2 title: CPA description: Cost per acquisition skip_invoice: 0 skip_selfbill: 0 skip_override: 0 schema: properties: website_types: items: $ref: '#/components/schemas/Partnership_Model' type: array type: object description: OK tags: - Partnership Models description: List all available partnership models. operationId: List Partnership Models summary: List Partnership Models components: schemas: Fraud_Incident_Base: properties: id: description: A unique ID for the incident type: string type: description: Which type of entity triggered this incident type: string enum: - ip_address - conversion - partner date: description: The date of the incident type: string time_window: description: Over how many days did we calculate the metric type: string status: description: Status of the record type: string enum: - active - deleted created_at: description: Timestamp of the record creation type: string deleted_at: description: Timestamp of the record deletion type: string required: - id - type - date - time_window - status - created_at - deleted_at type: object Fraud_Incident_Type_Partner: allOf: - $ref: '#/components/schemas/Fraud_Incident_Base' - type: object properties: partner: type: object properties: id: description: ID of the partner type: string name: description: The name of the partner type: string required: - id - name required: - partner Fraud_Incident_Type_IP_Address: allOf: - $ref: '#/components/schemas/Fraud_Incident_Base' - type: object properties: ip_address: type: string description: A hashed identifier for an IP address required: - ip_address Fraud_Incident_Metric_Basket: allOf: - oneOf: - $ref: '#/components/schemas/Fraud_Incident_Type_IP_Address' - $ref: '#/components/schemas/Fraud_Incident_Type_Partner' - type: object description: Properties unique to fraud incident baskets allOf: - type: object required: - metric properties: metric: type: string description: The metric name enum: - basket_variability_sku - type: object description: This is supplemental data for fraud incident baskets required: - data properties: data: type: object required: - conversions - total properties: total: type: number description: Total value of this basket conversions: type: array items: type: object title: The Items Schema required: - items - count - conversion_reference properties: items: type: array items: type: object required: - id - sku - category - status properties: id: type: string description: The conversion item ID sku: type: string description: The conversion item SKU category: type: string description: The conversion item category status: type: string description: Status of the conversion item count: type: integer description: The number of items conversion_reference: type: string description: The conversion reference - $ref: '#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/2' Fraud_Incident_Metric_Basic: allOf: - oneOf: - $ref: '#/components/schemas/Fraud_Incident_Type_IP_Address' - $ref: '#/components/schemas/Fraud_Incident_Type_Partner' - type: object description: Properties that all indicent types share required: - metric allOf: - type: object properties: metric: type: string description: The metric name enum: - volume_clicks - volume_conversions - conversion_ratio - $ref: '#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/2' Fraud_Incident_Metric_Conversion_Value: allOf: - oneOf: - $ref: '#/components/schemas/Fraud_Incident_Type_IP_Address' - $ref: '#/components/schemas/Fraud_Incident_Type_Partner' - type: object description: Properties for Conversion value allOf: - type: object required: - metric properties: metric: type: string description: The metric name enum: - conversion_value - allOf: - $ref: '#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/1' - type: object required: - data properties: data: type: object required: - currency properties: currency: type: string description: The campaigns default currency - $ref: '#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/2' Fraud_Incident_Metric_Ttc: allOf: - oneOf: - $ref: '#/components/schemas/Fraud_Incident_Type_IP_Address' - $ref: '#/components/schemas/Fraud_Incident_Type_Partner' - type: object description: Properties for ttc allOf: - type: object required: - metric properties: metric: type: string description: The metric name enum: - ttc - type: object description: This is supplemental data for fraud incidents ttc and conversion value required: - data properties: data: type: object required: - conversion_reference - conversion_items properties: conversion_reference: type: string description: The conversion reference conversion_items: type: array items: type: object required: - id - sku - category - status properties: id: type: string description: The conversion item ID sku: type: string description: The conversion item SKU category: type: string description: The conversion item category status: type: string description: Status of the conversion item - type: object description: This is supplemental data common to all fraud incidents required: - data properties: data: type: object required: - threshold - value properties: threshold: type: number description: The threshold for this metric value: type: number description: The actual value of this metric Network: properties: auto_approve_publishers: $ref: '#/components/schemas/YesOrNo' cm_client_id: type: string default_campaign_id: type: string network_application_id: type: string network_contact_email: type: string network_description: description: Description of the network type: string network_id: description: ID of the network type: string network_locale: $ref: '#/components/schemas/Locale' network_name: description: Name of the network type: string network_notes: description: Any additional notes for the network type: string type: object Network_Wrapper: properties: network: $ref: '#/components/schemas/Network' type: object Publisher: type: object properties: websites: items: $ref: '#/components/schemas/Publisher_Website_Wrapper' type: array us_tax_state: type: string reporting_identifier: type: string publisher_id: description: ID of the partner type: string network_status: $ref: '#/components/schemas/Status' network_notes: type: string network_id: description: ID of the network this partner belongs to type: string legal_entity: $ref: '#/components/schemas/Country' is_affiliate_user: $ref: '#/components/schemas/YesOrNo' gst_registered: type: string foreign_identifier: type: string databases: items: $ref: '#/components/schemas/Publisher_Database_Wrapper' type: array campaign_select: type: string abn: type: string account_name: type: string company_division: type: string company_name: type: string contact_email: type: string contact_locale: $ref: '#/components/schemas/Locale' contact_name: type: string default_currency: $ref: '#/components/schemas/Currency' description: description: Description of the partner type: string im_provider: type: string im_username: type: string is_foreign_network: $ref: '#/components/schemas/YesOrNo' description: Reporting only flag. All conversions will be automatically approved but will not be invoiceable. is_lead_user: $ref: '#/components/schemas/YesOrNo' operating_country: $ref: '#/components/schemas/Country' promotional_method: type: number promotional_method_name: type: string promotional_countries: type: array items: type: object properties: iso: type: string name: type: string uk_vat_registered: $ref: '#/components/schemas/YesOrNo' vat_number: type: number vertical: type: number vertical_name: type: string Publisher_Wrapper: properties: publisher: $ref: '#/components/schemas/Publisher' User_Publisher: type: object properties: user_name: type: string description: Username of the user email_address: type: string description: Email address of the user password: type: string description: Password of the user address1: type: string description: Address Line 1 of the user postcode: type: string description: Postcode of the user country: type: string description: ISO-2 country code of the user phone: type: string description: Phone number of the user signup_ip: type: string description: The signup IP address of the user firstname: type: string description: The first name of the user lastname: type: string description: The last name of the user address2: type: string description: Address Line 2 of the user address3: type: string description: Address Line 3 of the user address4: type: string description: Address Line 4 of the user locale: type: string description: Locale of the user user_id: type: string description: The ID of the user created: type: string description: Datetime stamp of when the user account was created network_id: type: string description: The network ID of which the user belongs to network_name: type: string description: The network name of which the user belongs to user_api_key: type: string description: The API key of the user account publisher: type: object properties: account_name: type: string description: Name of the partner vertical: type: string description: The vertical ID of the partner promotional_method: type: string description: The promotional method ID of the partner signup_ip: type: string description: The signup IP address of the partner entity_terms_id: type: string description: The agreed terms and conditions ID. The ID must be retrieved by retrieving the terms and conditions from the [network terms and conditions API.](#tag/Network-Terms-and-Conditions) network_terms_id: type: string description: The agreed network terms and conditions ID vat_number: type: string description: The VAT number of the partner description: type: string description: Description of the partner company_name: type: string description: Company name associated to the partner operating_country: type: string description: Country of operation for the partner reporting_timezone: type: string description: Reporting timezone of the partner. default_currency: type: string description: Default currency of the partner. phone: type: string description: Phone number of the partner. contact_name: type: string description: The contact name of the partner. contact_email: type: string description: The contact email of the partner. contact_locale: type: string description: The contact ISO locale for the partner. User_Publisher_Wrapper: properties: user: $ref: '#/components/schemas/User_Publisher' type: object Publisher_Website: properties: publisher_id: description: ID of the partner the website belongs to type: string website_id: description: ID of the partner website type: string active: $ref: '#/components/schemas/YesOrNo' primary: $ref: '#/components/schemas/YesOrNo' website_country: $ref: '#/components/schemas/Country' website_name: type: string website_type: type: number website_type_name: type: string website_url: type: string website_vertical: type: number website_vertical_name: type: string required: - website_url type: object Publisher_Website_Wrapper: properties: website: $ref: '#/components/schemas/Publisher_Website' type: object Publisher_Database: properties: database_id: description: ID of the partner database type: string publisher_id: description: ID of the partner the database belongs to type: string active: $ref: '#/components/schemas/YesOrNo' creation_method: type: string database_name: type: string female: type: number male: type: number max_age: type: number min_age: type: number size: type: number required: - database_name - creation_method - size type: object Publisher_Database_Wrapper: properties: database: $ref: '#/components/schemas/Publisher_Database' type: object Term_Wrapper: properties: database: $ref: '#/components/schemas/Term' type: object Term: properties: locale: $ref: '#/components/schemas/Locale' description: Locale of the terms ref_legal_entity_id: $ref: '#/components/schemas/Legal_Entities' description: Legal entity of the terms ref_terms_and_conditions_locale_id: description: Terms and conditions ID, used for partner signup type: string terms_and_conditions: description: Terms and condition content type: string tnc_type: enum: - entity - network type: string type: object Campaign_Wrapper: properties: campaign: $ref: '#/components/schemas/Campaign' type: object Campaign: oneOf: - properties: default_commission_rate: type: string type: object - properties: default_commission_value: type: string type: object properties: advertiser_icon: type: string nullable: true advertiser_id: description: ID of the brand the campaign should belong to type: string advertiser_name: description: Advertiser name type: string allow_deep_linking: $ref: '#/components/schemas/YesOrNo' allow_third_party_pixel: $ref: '#/components/schemas/YesOrNo' app_tracking_provider_tracking_link: type: string app_tracking_provider: type: string enum: - branch - partnerize append_url_parameters: type: string associated_campaigns: type: string automated_invoicing_date: type: number automated_invoicing_po_number: type: string auto_approve_publisher: $ref: '#/components/schemas/YesOrNo' auto_rejected_ips: nullable: true type: string basket_value_cap: nullable: true type: number budget_summary_interval: nullable: true type: number budget_summary_start_time: nullable: true type: string campaign_currency_conversions: {} campaign_id: description: ID of the campaign type: string campaign_icon: description: URL to image type: string campaign_icon_upload: description: base64 encoded image type: string campaign_languages: nullable: true properties: {} type: object campaign_logo: nullable: true type: string campaign_notes: type: string campaign_overloads: {} commission_by_meta: type: string commission_by_meta_label: type: string commissions: {} conversion_hiatus_period: type: number conversion_type: type: string cookie_period: type: number cookie_status: nullable: true type: string deeplink_method: type: string enum: - standard - direct default_currency: $ref: '#/components/schemas/Currency' default_override: type: number deferred_lead_submission: nullable: true type: string description: nullable: true properties: en: type: string type: object destination_url: type: string dont_consolidate: $ref: '#/components/schemas/YesOrNo' dont_invoice: $ref: '#/components/schemas/YesOrNo' extra_restricted_deep_linking: type: string force_approve_period: type: number hidden_campaign: $ref: '#/components/schemas/YesOrNo' invoice_address_1: nullable: true type: string invoice_address_2: nullable: true type: string invoice_address_3: nullable: true type: string invoice_address_4: nullable: true type: string invoice_address_country: nullable: true type: string invoice_address_postcode: nullable: true type: string invoice_company: nullable: true type: string invoice_contact: nullable: true type: string invoice_only: nullable: true type: string ip_tracking_time: type: number is_cpc: $ref: '#/components/schemas/YesOrNo' lead_confirmation_url_fail: type: string lead_confirmation_url_success: type: string meta_field_values_field_limit: type: number meta_field_values_total_limit: type: number multiple_conversions_per_click: anyOf: - enum: - y - n type: string - enum: - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: number network_fee: nullable: true type: string pay_publisher_directly: $ref: '#/components/schemas/YesOrNo' payment_date: nullable: true type: string prepend_url_string: description: Prepend all destination URLs nullable: true type: string promotional_countries: type: array items: type: object properties: iso: type: string example: US name: type: string example: United States recurring_payment_setup: $ref: '#/components/schemas/YesOrNo' report_meta_purge_period: description: The number of days that Meta Reports will be stored before being purged nullable: true type: number reporting_timezone: enum: - Australia/Sydney - UTC - Europe/London - CET - GMT type: string restricted_deep_linking: $ref: '#/components/schemas/YesOrNo' secure_tracking: $ref: '#/components/schemas/YesOrNo' short_link_subdomain: type: string status: $ref: '#/components/schemas/Status' terms: nullable: true properties: en: properties: terms: type: string type: object type: object test_mode: $ref: '#/components/schemas/YesOrNo' title: type: string tq_auto_approve: type: number tq_enabled: $ref: '#/components/schemas/YesOrNo' tq_enabled_publishers: type: string tracking_method: enum: - pixel - api - s2s type: string tracking_subdomain: nullable: true type: string unique_conversion_refs: enum: - y - n - ignore type: string vertical_id: type: number vertical_name: type: string week_start: type: string required: - advertiser_id - title - destination_url type: object Brand_Account_Wrapper: properties: advertiser: $ref: '#/components/schemas/Brand_Account' type: object Brand_Account: properties: account_name: description: Unique brand account name type: string address1: description: 1st line of the address type: string address2: description: 2nd line of the address nullable: true type: string address3: description: 3rd line of the address nullable: true type: string address4: description: 4th line of the address nullable: true type: string advertiser_icon: description: Url path to image type: string nullable: true advertiser_id: description: ID of the brand type: string budget_summary_interval: nullable: true type: string budget_summary_start_time: nullable: true type: string company_name: type: string contact_email: type: string country: description: Country of the address $ref: '#/components/schemas/Country' current_balance: nullable: true type: string default_currency: $ref: '#/components/schemas/Currency' display_name: description: Name shown to publishers under brand campaign management type: string payment_currency: $ref: '#/components/schemas/Currency' phone: description: Primary contact telephone number type: string phone_area: description: Phone prefix to declare country or region nullable: true type: string postcode: description: Postcode/Zipcode attached to the address type: string pre_payment: nullable: true type: string signup_ip: type: string status: $ref: '#/components/schemas/Status' vat_number: nullable: true type: string required: - account_name - company_name - address1 - country - postcode - phone - signup_ip type: object Voucher_Code_Wrapper: properties: voucher_code: $ref: '#/components/schemas/Voucher_Code' type: object Voucher_Code: properties: commission_groups: description: Commission groups associated with the voucher items: $ref: '#/components/schemas/Commission_Group_Wrapper' type: array description: type: string voucher_code: type: string active: $ref: '#/components/schemas/YesOrNo' campaign_id: description: ID of the Campaign type: string on_expiry: type: string on_invalid_user: type: string voucher_code_id: description: ID of the Voucher Code type: string start_date_time: type: string end_date_time: type: string type: object Commission_Group_Wrapper: properties: commission_group: $ref: '#/components/schemas/Commission_Group' type: object Commission_Group: properties: campaign_id: description: ID of the campaign type: string description: type: string name: type: string publishers: description: IDs of the partners to be associated with the group items: type: string type: array active: $ref: '#/components/schemas/YesOrNo' commission_group_id: description: ID of the commission group type: string last_modified: type: string required: - name - campaign_id type: object Creative_Wrapper: properties: creative: $ref: '#/components/schemas/Creative' type: object Creative: properties: creative_id: description: ID of the creative type: string advertiser_reference: type: string creative_items: items: $ref: '#/components/schemas/Creative_Item' type: array creative_tracking_link: type: string creative_tracking_link_rotate: type: string default_specific_creative_id: type: string description: type: string destination: type: string dynamic_tracking_link: type: string height: type: number html_tracking_link: type: string limits: type: string preview: type: string width: type: number tags: type: string active: $ref: '#/components/schemas/YesOrNo' campaign_id: description: ID of the campaign type: string creative_type_id: type: number custom_append_url_parameters: type: string custom_prepend_url_parameters: type: string start_date_time: type: string end_date_time: type: string created_by: type: string created_at: type: string required: - creative_type_id type: object Creative_Item: properties: content_type: type: string creative_item_id: description: ID of the creative item type: string description: type: string filename: type: string img_url: type: string preview: type: string specific_destination: type: string created_by: type: string created_at: type: string tags: type: string active: $ref: '#/components/schemas/YesOrNo' campaign_id: description: ID of the campaign type: string creative_type_id: type: number custom_append_url_parameters: type: string custom_prepend_url_parameters: type: string required: - creative_type_id type: object Creative_Tag: properties: campaign_id: description: ID of the Campaign type: string creative_tag_id: description: ID of the Creative Tag type: string creatives: items: properties: creative_id: description: ID of the Creative type: string creative_item_id: description: ID of the Creative Item type: string type: array name: type: string created_by: type: string created_at: type: string required: - name type: object Creative_Tag_Wrapper: properties: creative_tag: $ref: '#/components/schemas/Creative_Tag' type: object Feed_Wrapper: properties: feed: $ref: '#/components/schemas/Feed' type: object Feed: properties: active: $ref: '#/components/schemas/YesOrNo' dynamic: type: number feed_id: description: ID of the Product Feed type: string fetch_frequency: type: number filesize: type: number last_processed: description: UNIX timestamp type: number location: type: string name: type: string updated: description: UNIX timestamp type: number type: object Transaction_Query_Wrapper: properties: transaction_query: $ref: '#/components/schemas/Transaction_Query' type: object Transaction_Query: properties: campaign: properties: advertiser_id: type: string campaign_id: type: string created: type: string created_by: type: string default_override: type: string hidden_campaign: $ref: '#/components/schemas/YesOrNo' last_modified: type: string network_fee: type: string payment_date: type: string reporting_timezone: $ref: '#/components/schemas/Timezones' status: $ref: '#/components/schemas/Status' title: type: string type: type: string vertical_id: type: number week_start: type: string type: object campaign_id: type: string camref: type: string conversion_currency: $ref: '#/components/schemas/Currency' conversion_date_time: type: string conversion_id: type: string conversion_reference: type: string conversion_value: type: number created_at: type: string current_state: $ref: '#/components/schemas/Transaction_Query_State' expected_commission: type: number notes: type: string publisher: properties: agreed_to_latest_network_terms: $ref: '#/components/schemas/YesOrNo' created: type: string created_by: type: string name: type: string network_id: type: string network_status: type: string publisher_id: type: string ref_terms_and_conditions_locale_id: type: string reporting_timezone: $ref: '#/components/schemas/Timezones' signup_ip: type: string week_start: type: string type: object publisher_id: type: string publisher_reference: type: string state_history: $ref: '#/components/schemas/Transaction_Query_State_History' transaction_query_id: type: string transaction_query_type: $ref: '#/components/schemas/Transaction_Query_Type' updated_at: type: string type: object Transaction_Query_State: enum: - pending - approved - rejected type: string Transaction_Query_State_History: properties: conversion_expected_commission: type: number conversion_item_id: type: string created_at: type: string notes: type: string state: $ref: '#/components/schemas/Transaction_Query_State' transaction_query_id: type: string transaction_query_state_id: type: string user_id: type: string type: object Transaction_Query_Type: enum: - untracked - incorrect_commission - declined type: string Transaction_Query_Reason: properties: campaign_id: type: string created_at: type: string reason: type: string transaction_query_reason_id: type: string type: object Invoice_Wrapper: properties: invoice: $ref: '#/components/schemas/Invoice' type: object Invoice: properties: average_conversion_age: type: number campaign_id: description: ID of the Campaign type: string creation_date: type: string currency: $ref: '#/components/schemas/Currency' download: description: URL for PDF download type: string invoice_id: description: ID of the Invoice type: string invoice_net_value: type: number invoice_reference: type: string invoice_total_value: type: number invoice_vat_value: type: number invoiced: type: string item_download: description: URL for CSV item download type: string merchant_invoice_id: description: Optional merchant reference type: string paid_currency: $ref: '#/components/schemas/Currency' payment_date: type: string payment_due_by_date: type: string payment_reference: description: Optional payment reference type: string publisher_commission: type: number publisher_override: type: number set_end_date: type: string set_start_date: type: string set_timezone: $ref: '#/components/schemas/Timezones' status: enum: - created - sent - paid type: string vat_rate: type: number type: object Deal_Wrapper: properties: campaign_deal: $ref: '#/components/schemas/Deal' type: object Deal: properties: active: $ref: '#/components/schemas/YesOrNo' advertiser_reference: type: string category: type: string country_iso: description: Whether it applies to a specific country $ref: '#/components/schemas/Country' coupon_code: description: A specific coupon or voucher code associated with the deal type: string description: type: string destination: description: A deeplink to the specific deal location type: string end_date_time: description: Timezone specific timestamp to indicate the deal expiry time type: string offer_type: description: The type of offer enum: - coupon - offer - sale type: string offer_value: description: The unit to attribute to the `offer_type` type: string start_date_time: description: Timezone specific timestamp to indicate the start of the deal type: string terms: description: Specific terms for the deal type: string title: type: string required: - title - description - offer_type - offer_value type: object Vertical: properties: vertical: properties: description: type: string name: description: The vertical name type: string vertical_id: description: ID of the vertical type: number type: object type: object Reference_Locale: properties: locale: properties: code: description: The iso code of the locale type: string printable_name: description: The dictionary word for the locale type: string type: object type: object Reference_Currency_Country: properties: currency_country: properties: currency_iso: properties: AED: description: The ISO value for the currency properties: country_iso: description: An array of ISO values for the compatible currencies items: $ref: '#/components/schemas/Country' type: array type: object type: object type: object type: object Reference_Country: properties: country: properties: area_sq_km: type: number capital: type: string continent_iso: type: string continent_name: type: string currency_iso: description: The ISO of the currency type: string east: type: string fips_code: type: string geoname_id: type: number iso: description: The ISO code for the country type: string iso3: type: string iso_numeric: type: string languages: type: string north: type: string population: type: number printable_name: description: The dictionary word for the locale type: string ref_country_id: description: ID of the country type: number south: type: string west: type: string zone: type: string type: object type: object Reference_Currency: properties: currency: properties: currency_id: description: The id of the currency type: number iso: description: The ISO value for the currency type: string minor_unit: description: The number of decimal places type: number name: description: The name of the currency type: string type: object type: object Campaign_Extra_Field: properties: campaign_extra_field: properties: campaign_extra_field_id: description: The id of the extra field type: number field_comment: type: string field_default_value: description: The value assigned if no value is passed in type: string field_name: description: The name of the extra field type: string type: object type: object US_State: properties: us_state: properties: code: type: string printable_name: type: string type: object type: object Timezone: properties: timezone: properties: description: type: string local_time: type: string name: type: string ref_timezone_id: type: number utc_offset: type: string type: object type: object Device: properties: device: properties: ref_device_id: type: number title: type: string description: type: string skip_invoice: type: number skip_selfbill: type: number skip_override: type: number key: type: string type: object type: object User_Context: properties: user_context: properties: ref_user_context_id: type: number title: type: string description: type: string skip_invoice: type: string skip_selfbill: type: string skip_override: type: string key: type: string type: object type: object Traffic_Source: properties: traffic_source: properties: ref_traffic_source_id: type: number title: type: string description: type: string skip_invoice: type: string skip_selfbill: type: string skip_override: type: string type: object type: object Website_Type: properties: website_type: properties: description: type: string name: description: The name of the website type type: string website_id: description: The id of the website type type: number type: object type: object Promotional_Method: properties: promotional_method: properties: description: description: Description of the promo method type: string name: description: The name of the promo method type: string promotional_method_id: description: The id of the promo method type: number type: object type: object Conversion_Type: properties: conversion_type: properties: available_to_invoice: $ref: '#/components/schemas/YesOrNo' available_to_selfbill: $ref: '#/components/schemas/YesOrNo' conversion_type: description: The name of the extra field type: string conversion_type_id: description: The id of the conversion type type: number description: type: string exclude_from_override_rules: $ref: '#/components/schemas/YesOrNo' type: object type: object Conversion_Metric: properties: partnership_model: properties: ref_conversion_metric_id: type: number title: type: string description: type: string skip_invoice: type: string skip_selfbill: type: string skip_override: type: string type: object type: object Partnership_Model: properties: partnership_model: properties: ref_partnership_model_id: type: number title: type: string description: type: string skip_invoice: type: string skip_selfbill: type: string skip_override: type: string type: object type: object Brand_Overview_Base: properties: count: type: number execution_time: type: string start_date_time: type: string end_date_time: type: string total_impression_count: type: number total_click_count: type: number total_conversion_count: description: 'conversion count for each currency. E.g. "USD": 25, "EUR": 37' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number total_commission_value: description: 'commission value for each currency. E.g. "USD": 324.65, "EUR": 583.59' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number total_order_value: description: 'order value for each currency. E.g. "USD": 4000, "EUR": 5400.25' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number total_publisher_commission_value: description: 'commission value for each currency. E.g. "USD": 400, "EUR": 311.215' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number total_rejection_rate: properties: all_conversions_count: type: number percentage: type: number rejected_conversions_count: type: number type: object total_quantity: type: number total_clickthrough_rate: type: number total_ordersize_avg: type: number Brand_Overview_Currency_Stats: properties: impressions: type: number clicks: type: number currency: items: properties: currency_iso: description: key value pairs where the `currency iso` is the key and the value is an object containing a set of stats for the currency properties: commissions: type: number conversions: type: number ordervalue: type: number quantity: type: number publisher_commission: type: number ordervalue_avg: type: number conversion_rate: type: number earnings_per_click: type: number ordersize_avg: type: number type: object type: array quantity: type: number rejection_rate: properties: percentage: type: number all_conversions_count: type: number rejected_conversions_count: type: number type: object clickthrough_rate: type: number ordersize_avg: type: number Brand_Overview_Primary: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: publishers: items: properties: publisher: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: publisher_id: type: string account_name: type: string type: array Brand_Overview_Country: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: countrys: items: properties: country: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: country_iso: $ref: '#/components/schemas/Country' type: array Brand_Overview_Self: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: campaigns: items: properties: campaign: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: campaign_id: type: string title: type: string type: array Brand_Overview_Product: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: products: items: properties: product: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: product: type: string type: array Brand_Overview_Pubref: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: pubrefs: items: properties: pubref: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: reserved_tag_name: type: boolean pubref: type: string type: array Brand_Overview_Adref: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: adrefs: items: properties: adref: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: adref: type: string type: array Brand_Overview_Creative: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: creatives: items: properties: creative: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: reserved_tag_name: type: boolean creative_id: type: string creative_description: type: string creative_items: items: $ref: '#/components/schemas/Creative_Item' type: array type: array Brand_Overview_Agent: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: agents: items: properties: agent: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: agent_name: type: string agent_items: items: {} type: array type: array Brand_Overview_Custref: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: custrefs: items: properties: custref: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: custref: type: string type: array Brand_Overview_Type: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: types: items: properties: type: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: type: type: number type: array Brand_Overview_Device: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: devices: items: properties: device: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: device_id: type: number device_title: type: string type: array Brand_Overview_Source: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: sources: items: properties: source: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: source_id: type: number source_title: type: string type: array Brand_Overview_Partnership: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: partnerships: items: properties: partnership: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: partnership_id: type: number partnership_title: type: string type: array Brand_Overview_Metric: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: metrics: items: properties: metric: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: metric_id: type: number metric_title: type: string type: array Brand_Overview_Context: allOf: - $ref: '#/components/schemas/Brand_Overview_Base' - type: object properties: contexts: items: properties: context: allOf: - $ref: '#/components/schemas/Brand_Overview_Currency_Stats' - type: object properties: context_id: type: number context_title: type: string type: array Brand_Overview_Period_Stats: properties: impressions: type: number clicks: type: number currency: items: properties: currency_iso: description: key value pairs where the `currency iso` is the key and the value is an object containing a set of stats for the currency properties: commissions: type: number conversions: type: number ordervalue: type: number quantity: type: number publisher_commission: type: number ordervalue_avg: type: number conversion_rate: type: number earnings_per_click: type: number ordersize_avg: type: number type: object type: array quantity_all: type: number conversions_all: type: number conversions_rej: type: number rejection_rate: type: number clickthrough_rate: type: number ordersize_avg: type: number type: object Brand_Overview_Period: properties: totals: $ref: '#/components/schemas/Brand_Overview_Period_Stats' start_block: type: number end_block: type: number start_time: type: string end_time: type: string stats: $ref: '#/components/schemas/Brand_Overview_Period_Stats' Brand_Overview_Multidate_Current: properties: period: properties: current: $ref: '#/components/schemas/Brand_Overview_Period' type: object utc_offset: type: number Brand_Overview_Multidate_Ranges: properties: period: items: properties: range{index}: description: an indexed range. E.g. range0, range1, etc. $ref: '#/components/schemas/Brand_Overview_Period' type: object type: array utc_offset: type: number Brand_Conversions: properties: total_conversion_count: description: 'conversion count for each currency. E.g. "USD": 25, "EUR": 37' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number total_commission_value: description: 'total commission value for each currency. E.g. "USD": 250.5, "EUR": 180.9' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number total_publisher_commission: description: 'total publisher commission for each currency. E.g. "USD": 250.5, "EUR": 180.9' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number total_value: description: 'total order value. E.g. "USD": 435.5, "EUR": 267.9' type: object properties: currency_iso: description: 'key value pairs where the currency iso is the key. E.g. EUR: 37' type: number start_date_time_utc: type: string end_date_time_utc: type: string start_date_time: type: string end_date_time: type: string limit: type: number meta_data: type: array description: Key value pairs of meta data items: properties: key: description: A key value pair. type: string count: type: number execution_time: type: string conversions: type: array items: $ref: '#/components/schemas/Conversion_Data' type: object Conversion_Data: properties: conversion_id: description: Id of the conversion example: 111111l314 type: string campaign_id: description: Id of the campaign example: 111111l29 type: string publisher_id: description: Id of the partner example: 111111l92 type: string conversion_time: type: string cookie_id: type: string creative_type: type: number creative_id: type: number specific_creative_id: type: number currency: $ref: '#/components/schemas/Currency' advertiser_reference: type: string conversion_reference: type: string customer_type: enum: - new - existing type: string referer_ip: type: string source_referer: type: string last_modified: type: string conversion_type: description: the conversion type id type: number country: $ref: '#/components/schemas/Country' customer_reference: type: string ref_device_id: type: number ref_partnership_model_id: type: number ref_traffic_source_id: type: number ref_conversion_metric_id: type: number ref_user_context_id: type: number campaign_title: type: string publisher_name: type: string click: $ref: '#/components/schemas/Click' ref_conversion_metric: type: string ref_device: type: string ref_partnership_model: type: string ref_traffic_source: type: string ref_user_context: type: string conversion_value: properties: conversion_status: $ref: '#/components/schemas/Conversion_Status' value: type: number commission: type: number publisher_commission: type: number meta_data: type: array description: Key value pairs of meta data items: properties: key: description: A key value pair. type: string conversion_items: type: array items: $ref: '#/components/schemas/Conversion_Item' was_disputed: type: boolean currency_original: $ref: '#/components/schemas/Currency' currency_conversion_rate: type: string conversion_lag: type: number clickref: type: string type: object Click: properties: click_id: type: string cookie_id: type: string campaign_id: description: Id of the campaign example: 111111l29 type: string publisher_id: description: Id of the partner example: 111111l92 type: string type: type: string status: type: string set_time: type: string set_ip: type: string last_used: type: number last_ip: type: string advertiser_reference: type: string referer: type: string creative_id: type: number creative_type: type: number specific_creative_id: type: number ref_device_id: type: number ref_traffic_source_id: type: number ref_partnership_model_id: type: number ref_user_context_id: type: number ref_device: type: string ref_traffic_source: type: string ref_partnership_model: type: string ref_user_context: type: string clickref: type: string type: object Brand_Click: properties: click_id: type: string cookie_id: type: string campaign_id: description: Id of the campaign example: 111111l29 type: string publisher_id: description: Id of the partner example: 111111l92 type: string type: type: string status: type: string set_time: type: string set_ip: type: string last_used: type: number last_ip: type: string advertiser_reference: type: string referer: type: string creative_id: type: number creative_type: type: number specific_creative_id: type: number ref_device_id: type: number ref_traffic_source_id: type: number ref_partnership_model_id: type: number ref_user_context_id: type: number clickref: type: string publisher_name: type: string type: object Conversion_Item: properties: conversion_item_id: type: string sku: type: number category: type: string item_value: type: number item_publisher_commission: type: number item_status: type: string invoice_id: type: string last_update: type: string display_to_publisher: enum: - 0 - 1 type: number approved_at: type: string item_status_id: type: number reject_reason: type: string voucher_codes: [] meta_data: type: array description: Key value pairs of meta data items: properties: key: description: A key value pair. type: string type: object Conversion_Status: enum: - pending - approved - rejected type: string Brand_Clicks: properties: unique_click_count: description: total count of unique clicks type: number start_date_time_utc: type: string end_date_time_utc: type: string start_date_time: type: string end_date_time: type: string limit: type: number offset: type: number count: type: number execution_time: type: string clicks: type: array items: $ref: '#/components/schemas/Brand_Click' type: object Brand_Filter_Set: properties: filter_set: properties: campaign_id: type: string created_at: type: string created_by: type: string data: type: string is_default: type: boolean name: type: string reporting_filter_set_id: type: string updated_at: type: string updated_by: type: string user_id: type: string type: object type: object Filter_Set_Body: content: application/json: schema: example: data: '{"report":{"pivot":"publisher","metric":"clicks"},"grouping":"","reportColumns":{},"currency":{"original":"GLOBAL","output":"GBP"},"statuses":{"approved":false,"pending":false,"rejected":false,"mixed":false},"period":["2017-02-13T00:00:00.000Z","2017-02-14T00:00:00.000Z"],"intervalCode":"PT1H","graphedCounterType":"clicks","compatibilityVersion":4}' is_default: false name: My lovely filters set properties: data: description: Must be a valid JSON string type: string is_default: type: boolean name: type: string required: - name - data type: object YesOrNo: enum: - y - n type: string Locale: enum: - bg - cs - da - de - de_at - en - en_au - en_ca - en_us - es - es_mx - el - et - fi - fl - fr - fr_ca - hu - id - it - jp - ko - ko_kr - lt - lv - ms_my - mt - my - nl - 'no' - pl - po - pt - pt_br - ro - ru - sg - sk - sl - sv - sv_se - th - tl - tr - vi - zh_cn - zh_hk type: string Status: type: string enum: - a - p - r - n Country: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string Currency: enum: - GBP - USD - EUR - JPY type: string Legal_Entities: enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' type: string Timezones: enum: - Australia/Sydney - UTC - Europe/London - CET - GMT type: string Publishers_V2_Filters: account_created: name: account_created description: Date range for when partners signed up in: query schema: type: string example: 2020-01-01..2021-01-01 campaign_ids: name: campaign_ids description: The publishers' campaign ids in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' campaign_statuses: name: campaign_statuses description: The publishers' campaign statuses in: query schema: oneOf: - type: string enum: - approved - requested - invited - rejected - available - type: array items: $ref: '#/components/schemas/Publishers_V2_Filters/campaign_statuses/schema/oneOf/0' commission_group_ids: name: commission_group_ids description: The publishers' commission group ids in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' company_name: name: company_name description: The publishers' company name in: query schema: type: string fields: name: fields description: CSV list of fields to be returned as part of the response in: query schema: type: string, enum: - account_created - address - campaigns - commission_groups - company_name - company_logo - contact_email - contact_name - default_currency - description - id - locale - metadata - name - operating_country - partner_collection_ids - phone_number - promotional_countries - promotional_method - reporting_identifier - vertical - websites - website_info - network_notes - network_id - signup_ip ids: name: ids description: Filter by partner IDs in: query schema: oneOf: - type: string - type: array items: type: string include_discovery: name: include_discovery description: Whether to include partners with pending requests from brand discovery or invites from partner discovery in: query schema: $schema: http://json-schema.org/draft-04/schema title: Boolean type: string enum: - y - n website_verified: name: website_verified description: Whether to filter partners by their primary website domain verification status in: query schema: type: boolean enum: - y - n limit: name: limit description: The number of records to retrieve in: query schema: type: integer locales: name: locales description: The publishers' contact locale (locale codes), see https://api.partnerize.com/reference/locale in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' network_statuses: name: network_statuses description: The publishers' network status. Choosing requested or invited will automatically enable the include_discovery option for convenience. in: query schema: oneOf: - type: string enum: - approved - pending - rejected - invited - requested - type: array items: $ref: '#/components/schemas/Publishers_V2_Filters/network_statuses/schema/oneOf/0' offset: name: offset description: Starting position in: query schema: type: integer operating_countries: name: operating_countries description: The publishers' operating countries (country isos), see https://api.partnerize.com/reference/country in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' partner_collection_id: name: partner_collection_id description: Filter by partner collection ID in: query schema: type: string promotional_countries: name: promotional_countries description: The publishers' promotional countries (country isos), see https://api.partnerize.com/reference/country in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' promotional_method_ids: name: promotional_method_ids description: The publishers' promotional methods , see https://api.partnerize.com/reference/promotional_method in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' publisher_email: name: publisher_email in: query schema: type: string publisher_name: name: publisher_name description: Search by the publishers' company name, falling back the publisher name in: query schema: type: string publisher_tag_ids: name: publisher_tag_ids in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' publisher_website: name: publisher_website in: query schema: type: string reporting_identifier: name: reporting_identifier in: query schema: type: string search: name: search description: Search for matching publishers in: query schema: type: string sort: name: sort description: Order results in: query schema: type: string example: name vertical_ids: name: vertical_ids description: The publishers' verticals, see https://api.partnerize.com/reference/vertical in: query schema: $ref: '#/components/schemas/Publishers_V2_Filters/ids/schema' parameters: campaignId: name: campaignId description: The ID of the Campaign in: path required: true schema: type: string example: 111111l1