openapi: 3.0.1 info: title: Partnerize Partners 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 tags: - description: Once funds have been received from the Brand, Partnerize will allocate all Commissions to the relevant Partners. name: Self-billing - 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: 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\ \ 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/partner/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 your Partner ID in the\ \ scope:\n\n\n```\n{\n \"scope\":{\n \"partner\": \"partner_id\"\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 across\ \ your top 10 campaigns broken down 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_partner_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 `/v3/partner/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_partner_commission\"\n ],\n \"group_by\":[\n \"campaign\"\ ,\n \"country\",\n \"currency\"\n ],\n \"order_by\":[\n {\n\ \ \"field\":\"total_partner_commission\",\n \"direction\":\"DESCENDING\"\ \n }\n ],\n \"top\":10,\n \"scope\":{\n \"partner\": \"partner_id\"\ \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 Campaign\ \ Commision for approved and pending Converisons for one campaign broken down\ \ by Campaign 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/partner/analytics/conversions/explode`\ \ endpoint like in the previous example above.\n\n\n```\n+------------+---------------+----------+---------------------------+\n\ | campaign_id | campaign_name | status | total_partner_commission |\n| \ \ | | | |\n+-------------+---------------+----------+--------------------------+\n\ | 1 | Campaign 1 | pending | 200.00 |\n+-------------+---------------+----------+--------------------------+\n\ | 1 | Campaign 1 | approved | 150.00 |\n+-------------+---------------+----------+--------------------------+\n\ | 2 | Campaign 2 | pending | 350.00 |\n+-------------+---------------+----------+--------------------------+\n\ | 2 | Campaign 2 | approved | 100.00 |\n+-------------+--------------+----------+---------------------------+\n\ ``` \n\nTo do the filtering it requires a `filter_by` property for both the conversion\ \ status and `campaign_id`\n\n```\n\"filter_by\":[\n {\n \"field\":\"conversion_status\"\ ,\n \"operator\":\"EQUALS\",\n \"value\":[\n \"approved\",\n\ \ \"pending\"\n ]\n },\n {\n \"field\":\"campaign_id\",\n\ \ \"operator\":\"EQUALS\",\n \"value\":[\n \"campaign_id\"\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 \"partner\"\ : \"partner_id\"\n },\n \"filter_by\":[\n {\n \"field\":\"conversion_status\"\ ,\n \"operator\":\"EQUALS\",\n \"value\":[\n \"approved\"\ ,\n \"pending\"\n ]\n },\n {\n \"field\"\ :\"campaign_id\",\n \"operator\":\"EQUALS\",\n \"value\":[\n \ \ \"campaign_id\"\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 all 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/partner/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 \"partner\": \"partner_id\"\ \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. The zero filling\ \ is what makes the Timeseries endpoint ideal for creating charts and graphs.\ \ Again, we highly recommend this over using the Explode endpoint.\n\nUse the\ \ POST method on the URI `/v3/partner/analytics/conversions/timeseries`.\n\nWith\ \ the request body of: \n\n```\n{\n \"metrics\":[\n \"total_conversion_items\"\ ,\n \"total_partner_commission\"\n ],\n \"output_currency\":\"GBP\",\n\ \ \"interval\":{\n \"period\":\"P1D\"\n },\n \"scope\":{\n \"\ partner\": \"partner_id\"\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_order_value` 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_partner_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/partner/analytics//\n```\n\nFor example, the\ \ URI for using `explode` on the `conversions` data source would be:\n\n```\n\ /v3/partner/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| publisher_reference | publisher_reference \ \ |\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 your `partner_id`:\n\ \n\n```\n\"scope\": {\n \"partner_id\": \"partner_id\",\n}\n\n```\n\nThe example\ \ above will first check you have access to the `partner_id`. If you do have access,\ \ you will receive results for the partner.\n\nIf you do not have access to the\ \ requested `partner` you will receive a `403 Forbidden` response.\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\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##### 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: 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: My Brands description: Information about the brands the authenticated partner is associated with - name: Campaign Terms and Conditions description: Endpoints for retrieving campaign terms and conditions which are in affect. - name: Campaign Terms and Conditions Acknowledgments description: Endpoints for retrieving and management the confirmations of changes existing campaign terms and conditions.

Each change to a set of campaign terms and conditions are recoreded, these changes can be flag as been acknowledged by a user by creating a campaign terms and conditions acknowledgment instances. - name: Current User description: Endpoints for current User - 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. ' x-tagGroups: - name: Partner Management (v1) tags: - Partner Details - Websites - Databases - name: Campaign Management (v1 and v2) tags: - Brand Discovery (v2) - Campaigns (v1) - Campaign Invitations (v2) - Campaign Requests (v2) - Campaign References (v1) - Creatives (v1) - Feeds (v1) - Terms and Conditions - Voucher Codes (v1) - name: Campaign Commissions (v2) tags: - Attribution - Commissions - Commission Groups (v1) - Promotional Commissions - Tiered Commissions - Voucher Commissions - name: Payments (v1) tags: - Transaction Queries - Self-billing - Payment Details - Available Commission - Summary - name: Tracking Links Management (v2) tags: - Tracking Links - name: Background Jobs (v1) tags: - Jobs (v1) - name: Reporting (v1) tags: - Partner Conversions - Partner Clicks - Partner Payable - Exports - name: Analytics (v3) tags: - Introduction - Tutorials - Clicks - Conversions - Impressions - name: Reference (v1) tags: - Countries - Currencies - Devices - Timezones - User Contexts - Traffic Sources - Conversion Types - Conversion Metrics - Partnership Models - name: Participations (v3) tags: - Participations - name: Partnerize Tags (v3) tags: - Partnerize Tags - Partnerize Tag Features - name: Brands (v3) tags: - My Brands - name: Terms and Conditions (v3) tags: - Campaign Terms and Conditions - Campaign Terms and Conditions Acknowledgments - name: User (v3) tags: - Current User paths: /user/publisher/{publisher_id}/campaign/{status}: get: parameters: - description: ID of the partner example: 1l1007802 in: path name: publisher_id required: true schema: type: string - description: 'The status of the partner on the campaign + a - approved + p - pending + r - rejected' example: a in: path name: status 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_custom_terms_and_conditions_id: 10l176 campaign_custom_terms_and_conditions_title: Some fancy title 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 publisher_status: a 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 schema: properties: campaigns: items: $ref: '#/components/schemas/Partner_Campaign_Wrapper' type: array type: object description: OK tags: - Campaigns (v1) description: View all Campaigns that the Partner is associated with, along with the status of any Participation. operationId: List Campaigns summary: List Campaigns post: parameters: - description: ID of the partner example: 1l1007802 in: path name: publisher_id required: true schema: type: string - description: 'The status of the partner on the campaign + a - approved + p - pending + r - rejected' example: a in: path name: status 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 budget_summary_interval: null budget_summary_start_time: null campaign_currency_conversions: [] campaign_custom_terms_and_conditions_id: 10l176 campaign_custom_terms_and_conditions_title: Some fancy title 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 publisher_status: a 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: Partnerize 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: properties: campaigns: items: $ref: '#/components/schemas/Campaign' type: array type: object description: OK tags: - Campaigns (v1) description: 'This endpoint is now `Obsolete`. Use the [Create Campaign Requests](#operation/createCampaignRequests) endpoint instead.

Request access to one or more Campaigns. If a Campaign has any custom Terms and Conditions then the Partner must agree to these terms when requesting access. This is achieved by passing the latest `terms_id` from the relevant Campaign object. On certain Campaigns, you may find that a Partner will be auto-approved. However, some Brands will stipulate that they wish to review all Participations. Therefore, once access is requested the Partner will be shown as pending until this decision is made. Create new Participations by passing each `campaign_id` along with the relevant `terms_id` (if applicable) in an object within a `campaigns` array.' operationId: Request Access to Campaigns requestBody: content: application/json: schema: example: campaigns: - campaign_id: 10l176 terms_id: 111111l8 properties: campaigns: type: array type: object summary: Request Access to Campaigns (Obsolete) /user/publisher/{publisher_id}/campaign/{campaign_id}/voucher: get: parameters: - description: ID of the partner example: 1l1007802 in: path name: publisher_id required: true schema: type: string - description: ID of the campaign example: 111111l13 in: path name: campaign_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: count: 1 commission_fields: - conversion_type - customer_reference - advertiser_reference - country - vertical - sku - cookie_status - category - customer_type 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: commission_fields: items: type: string type: array voucher_codes: items: $ref: '#/components/schemas/Voucher_Code' type: array type: object description: OK tags: - Voucher Codes (v1) description: View all Voucher codes for a campaign that the Partner is associated with operationId: List Campaign Voucher Codes summary: List Campaign Voucher Codes /user/publisher/{publisher_id}/creative: get: parameters: - 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: campaign_creatives: - campaign_creative: campaign_id: 10l176 creatives: Banner: 1 Email: 1 Feed: 1 HTML: 1 HTML Form: 1 Text Link: 1 schema: properties: campaign_creatives: items: $ref: '#/components/schemas/Partner_Campaign_Creative' type: array type: object description: OK tags: - Creatives (v1) description: View a summary of all Creatives available on each participating Campaign. operationId: List all Creatives on each participating Campaign summary: List all Creatives on each participating Campaign /user/publisher/{publisher_id}/campaign/{campaign_id}/creative: get: parameters: - description: ID of the partner example: 1l1007802 in: path name: publisher_id required: true schema: type: string - description: ID of the campaign example: 10l176 in: path name: campaign_id required: true schema: type: string - description: Filter creatives by active status example: y in: query name: status required: false schema: $ref: '#/components/schemas/YesOrNo' - description: Filter by tags example: any-value in: query name: tags required: false schema: type: string - description: Filter by creative_type_id example: 111l10 in: query name: creative_type_id required: false schema: oneOf: - type: string - type: array items: 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 (v1) description: View all Creatives for the specified Campaign. operationId: List Creatives on a Campaign summary: List Creatives on a Campaign /user/publisher/{publisher_id}/feed: get: parameters: - description: ID of the partner example: 1l1007802 in: path name: publisher_id required: true schema: type: string - description: ID of the campaign to restrict output to example: 10l176 in: query name: campaign_id required: false schema: type: string - description: Filter by active example: y in: query name: active required: false schema: $ref: '#/components/schemas/YesOrNo' responses: '200': content: application/json; charset=utf-8: examples: response: value: campaigns: - campaign: campaign_id: 10l176 title: SportsBetting feeds: - campaign_feeds_id: 1011l10 campaign_id: 10l176 creative_id: '300441' filename: uk_destinations.csv filesize: 581427 filesize_compressed: 27691 last_processed: 1432235983 location: http://www.partnerize.com/ location_compressed: http://www.partnerize.com/ name: UK Destinations title: SportBetting updated: 1432228514 count: 1 execution_time: 0.53595 seconds schema: properties: campaigns: items: properties: campaign: allOf: - type: object properties: title: description: the name of the campaign type: string campaign_id: description: the Id of the campaign type: string - $ref: '#/components/schemas/Feed' type: array count: type: number execution_time: type: string type: object description: OK tags: - Feeds (v1) description: View all Feeds for the specified Partner. operationId: List all Available Feeds summary: List all Available Feeds /user/publisher/{publisher_id}/campaign/custom_terms/{custom_terms_id}: get: parameters: - description: ID of partner whose terms we want to read example: 1111l123 in: path name: publisher_id required: true schema: type: string - description: ID of custom terms example: 1111l564 in: path name: custom_terms_id required: true schema: type: string responses: '200': content: application/json; charset=utf-8: examples: response: value: custom_terms: - active: y campaign_custom_terms_and_conditions_id: 111111l43 campaign_id: 10l176 created: '2019-05-29 09:18:17' locale: pl terms: Terms and conditions content title: Terms and conditions title execution_time: 1.05973 seconds schema: properties: custom_terms: items: properties: active: $ref: '#/components/schemas/YesOrNo' locale: $ref: '#/components/schemas/Locale' description: Locale of the terms campaign_custom_terms_and_conditions_id: description: Terms and conditions ID' type: string terms: description: Terms and conditions content type: string title: description: Terms and conditions title type: string type: object type: array execution_time: type: string description: OK tags: - Terms and Conditions description: Retrieve Custom Terms and Conditions for a given partner and terms and conditions id operationId: Retrieve Partner Custom Terms and Conditions summary: Retrieve Partner Custom Terms and Conditions (v1) /reference/publisher/camref/{publisher_id}: get: parameters: - description: ID of partner example: 1111l123 in: path name: publisher_id required: true schema: type: string responses: '200': content: application/octet-stream; charset=utf-8: examples: response: value: Advertiser,Campaign,camref Leadsbox,Healthcare,6 description: OK tags: - Campaign References (v1) description: Lists campaign references operationId: List Campaign References summary: Lists Campaign References /user/publisher/{publisher_id}: parameters: - name: publisher_id in: path description: ID of the partner example: 1l1007802 required: true schema: type: string get: operationId: getPartner tags: - Partner Details summary: Retrieve Partner description: 'Outputs the specified partner. ' responses: '200': description: Partner Found content: application/json: schema: type: object additionalProperties: false properties: publisher: title: Partner type: object allOf: - $ref: '#/components/schemas/Partner' - properties: websites: type: array items: $ref: '#/components/schemas/Partner_Website' databases: type: array items: $ref: '#/components/schemas/Partner_Database' example: account_name: publisher123 company_name: Eve Online company_logo: https://console.partnerize.com/assets/logos/111111l2-1.jpg contact_email: info@partnerize.com contact_locale: en contact_name: Eve created: '2019-10-30 11:08:41' created_by: 111111l1 default_currency: USD im_provider: Skype im_username: evangeline is_affiliate_user: y is_us_registered: null legal_entity: AE network_id: 111111l1 network_status: a operating_country: AE phone: 555213456 phone_area: 44 promotional_method: 1 promotional_method_name: PPC publisher_id: 111111l2 reporting_timezone: Asia/Dubai signup_ip: 80.80.80.80 terms_and_conditions_id: 56 vertical: 2 vertical_name: Retail week_start: monday post: operationId: updatePartner tags: - Partner Details summary: Update Partner description: 'Update the specified Partner. ' requestBody: content: application/json: schema: properties: abn: type: string account_name: type: string campaign_select: type: string company_name: type: string company_division: type: string company_logo: type: string contact_email: type: string format: email contact_locale: $ref: '#/components/schemas/Locale' contact_name: type: string default_currency: $ref: '#/components/schemas/Currency' description: type: string description: 'HTML description of the partner. Supports the following tags: `, , , , ,

,

, 
,
                    , , , 
    , 
      , 
    1. ,
                    
      `'
                foreign_identifier:
                  type: string
                gst_registered:
                  type: string
                im_provider:
                  type: string
                im_username:
                  type: string
                is_affiliate_user:
                  $ref: '#/components/schemas/YesOrNo'
                is_foreign_network:
                  description: Reporting only flag. All conversions will be automatically
                    approved but will not be invoiceable.
                  $ref: '#/components/schemas/YesOrNo'
                is_lead_user:
                  $ref: '#/components/schemas/YesOrNo'
                network_notes:
                  type: string
                network_status:
                  $ref: '#/components/schemas/Status'
                operating_country:
                  $ref: '#/components/schemas/Country'
                phone:
                  type: string
                  description: Primary contact telephone number
                phone_area:
                  type: string
                  description: Phone prefix to declare country or region
                promotional_method:
                  type: integer
                publisher_id:
                  type: string
                  description: ID of the publisher
                  readOnly: true
                reporting_identifier:
                  type: string
                reporting_timezone:
                  type: string
                uk_vat_registered:
                  $ref: '#/components/schemas/YesOrNo'
                us_tax_state:
                  type: string
                vat_number:
                  type: integer
                vertical:
                  type: integer
                week_start:
                  type: string
              oneOf:
              - type: object
                title: Company Logo from URL
                properties:
                  company_logo:
                    description: Url of image to download. Supports PNG and JPEG only.
                    type: string
                    nullable: true
                example:
                  publisher_id: 1l10101
                  description: Example Partner
                  company_logo: https://example.com/logo.jpg
                  promotional_method: 9
              - type: object
                title: Company Logo via Upload
                properties:
                  company_logo_upload:
                    description: Base64 encoded data url of image to upoad. Supports
                      PNG and JPEG only.
                    type: string
                    nullable: true
                example:
                  publisher_id: 1l10101
                  description: Example Partner
                  company_logo_upload: data:image/jpg;base64,...
                  promotional_method: 9
      responses:
        '200':
          description: Partner Updated
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: status
                    type: object
                    properties:
                      status:
                        type: string
                      message:
                        type: string
                    example:
                      status: Updated
                      message: Publisher successfully updated
                  publisher:
                    title: Partner
                    type: object
                    allOf:
                    - $ref: '#/components/schemas/Partner'
                    - properties:
                        websites:
                          type: array
                          items:
                            $ref: '#/components/schemas/Partner_Website'
                        databases:
                          type: array
                          items:
                            $ref: '#/components/schemas/Partner_Database'
                    example:
                      account_name: publisher123
                      company_name: Eve Online
                      company_logo: https://console.partnerize.com/assets/logos/111111l2-1.jpg
                      contact_email: info@partnerize.com
                      contact_locale: en
                      contact_name: Eve
                      created: '2019-10-30 11:08:41'
                      created_by: 111111l1
                      default_currency: USD
                      im_provider: Skype
                      im_username: evangeline
                      is_affiliate_user: y
                      is_us_registered: null
                      legal_entity: AE
                      network_id: 111111l1
                      network_status: a
                      operating_country: AE
                      phone: 555213456
                      phone_area: 44
                      promotional_method: 1
                      promotional_method_name: PPC
                      publisher_id: 111111l2
                      reporting_timezone: Asia/Dubai
                      signup_ip: 80.80.80.80
                      terms_and_conditions_id: 56
                      vertical: 2
                      vertical_name: Retail
                      week_start: monday
  /user/publisher/{publisher_id}/website:
    get:
      parameters:
      - 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:
                    websites:
                    - website:
                        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
              schema:
                properties:
                  websites:
                    items:
                      $ref: '#/components/schemas/Partner_Website_Wrapper'
                    type: array
                type: object
          description: OK
      tags:
      - Websites
      description: Return the details of all Websites attached to the Partner account.
      operationId: List all Partner Websites
      summary: List all Partner Websites
    post:
      parameters:
      - 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:
                    websites:
                    - website:
                        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
              schema:
                properties:
                  websites:
                    items:
                      $ref: '#/components/schemas/Partner_Website_Wrapper'
                    type: array
                type: object
          description: OK
      tags:
      - Websites
      description: Create one or more Websites against the Partner entity. Each Website
        is sent as an array within a top level `websites` array.
      operationId: Create Partner Website
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - example:
                  active: y
                  primary: n
                  description: Demo Partner website
                  website_country: GB
                  website_name: null
                  website_type: 9
                  website_type_name: PPC
                  website_url: http://www.partnerize.com
                  website_vertical: 10
                  website_vertical_name: Technical
                $ref: '#/components/schemas/Partner_Website'
              - example:
                  websites:
                  - active: y
                    primary: n
                    description: Demo Partner website
                    website_country: GB
                    website_name: null
                    website_type: 9
                    website_type_name: PPC
                    website_url: http://www.partnerize.com
                    website_vertical: 10
                    website_vertical_name: Technical
                title: Array of Partner_Websites
                properties:
                  websites:
                    items:
                      $ref: '#/components/schemas/Partner_Website'
                    type: array
                type: object
      summary: Create Partner Website
    put:
      parameters:
      - 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:
                    websites:
                    - website:
                        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
              schema:
                properties:
                  websites:
                    items:
                      $ref: '#/components/schemas/Partner_Website'
                    type: array
                type: object
          description: OK
      tags:
      - Websites
      description: Update one or more Websites against the Partner entity. Each Website
        is sent as an array within a top level `websites` array and must contain its
        associated `website_id`.
      operationId: Update Partner Websites
      requestBody:
        content:
          application/json:
            schema:
              example:
                websites:
                - active: y
                  primary: n
                  description: Demo Partner website
                  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
              properties:
                websites:
                  items:
                    $ref: '#/components/schemas/Partner_Website'
                  type: array
              type: object
      summary: Update Partner Websites
  /user/publisher/{publisher_id}/website/{website_id}:
    get:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_id
        required: true
        schema:
          type: string
      - description: ID of the partner website
        example: 11l18694
        in: path
        name: website_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    website:
                      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
              schema:
                $ref: '#/components/schemas/Partner_Website_Wrapper'
                type: object
          description: OK
      tags:
      - Websites
      description: Retrieves the specified partner website.
      operationId: Retrieve a Partner Website
      summary: Retrieve a Partner Website
  /user/publisher/{publisher_id}/database:
    get:
      parameters:
      - 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:
                    databases:
                    - database:
                        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
              schema:
                properties:
                  databases:
                    items:
                      $ref: '#/components/schemas/Partner_Database_Wrapper'
                    type: array
                type: object
          description: OK
      tags:
      - Databases
      description: Return the details of all Databases attached to the Partner account.
      operationId: List Partner Databases
      summary: List Partner Databases
    post:
      parameters:
      - 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:
                    databases:
                    - database:
                        active: y
                        creation_method: Email
                        database_id: 111111l300347
                        database_name: PHG Test Database
                        female: 50
                        male: 50
                        max_age: 77
                        min_age: 25
                        publisher_id: 1l1007802
                        size: 53000
              schema:
                properties:
                  databases:
                    items:
                      $ref: '#/components/schemas/Partner_Database'
                    type: array
                type: object
          description: OK
      tags:
      - Databases
      description: Create one or more Databases against the partner entity. Each Database
        is sent as an array within a top level `databases` array.
      operationId: Create Partner Database
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - example:
                  active: y
                  creation_method: Email
                  database_name: Partnerize Test Database
                  female: 50
                  male: 50
                  max_age: 77
                  min_age: 25
                  size: 53000
                $ref: '#/components/schemas/Partner_Database'
              - example:
                  databases:
                  - active: y
                    creation_method: Email
                    database_name: PHG Test Database
                    female: 50
                    male: 50
                    max_age: 77
                    min_age: 25
                    size: 53000
                title: Array of Partner_Databases
                properties:
                  databases:
                    items:
                      $ref: '#/components/schemas/Partner_Database'
                    type: array
                type: object
      summary: Create Partner Database
    put:
      parameters:
      - 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:
                    databases:
                    - database:
                        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
              schema:
                properties:
                  databases:
                    items:
                      $ref: '#/components/schemas/Partner_Database_Wrapper'
                    type: array
                type: object
          description: OK
      tags:
      - Databases
      description: Update one or more Databases against the Partner entity. Each Database
        is sent as an array within a top level `databases` array and must contain
        its associated `database_id`.
      operationId: Update Partner Databases
      requestBody:
        content:
          application/json:
            schema:
              example:
                databases:
                - active: y
                  creation_method: Email
                  database_id: 111111l300347
                  database_name: Partnerize Test Database
                  female: 50
                  male: 50
                  max_age: 77
                  min_age: 25
                  size: 53000
              properties:
                databases:
                  items:
                    $ref: '#/components/schemas/Partner_Database_Wrapper'
                  type: array
              type: object
      summary: Update Partner Databases
  /user/publisher/{publisher_id}/database/{database_id}:
    get:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_id
        required: true
        schema:
          type: string
      - description: ID of the partner database
        example: 111111l300347
        in: path
        name: database_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    database:
                      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
              schema:
                $ref: '#/components/schemas/Partner_Database_Wrapper'
          description: OK
      tags:
      - Databases
      description: Retrieves the specified Partner Database.
      operationId: Retrieve a Partner Database
      summary: Retrieve a Partner Database
  /user/publisher/{publisher_id}/tq:
    get:
      parameters:
      - 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: query
        name: campaign_id
        required: false
        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:
                        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 Publisher
                          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
        '401':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    error:
                      message: 'Permission Denied: User cannot perform tq_read action
                        on publisher-1l1007802'
                      type: Access Permission Denied
              schema:
                properties:
                  error:
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                    type: object
                type: object
          description: Unauthorized
      tags:
      - Transaction Queries
      description: Return the details of all Transaction Queries created by the Partner
        account.
      operationId: List Transaction Queries
      summary: List all Transaction Queries
  /user/publisher/{publisher_id}/tq/create:
    post:
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    execution_time: 1.16076 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:
                      fields: {}
                      message: transaction_queries not found
                      type: Validation Fail
              schema:
                properties:
                  error:
                    properties:
                      fields:
                        properties: {}
                        type: object
                      message:
                        type: string
                      type:
                        type: string
                    type: object
                type: object
          description: Bad Request
        '401':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    error:
                      message: 'Permission Denied: User cannot perform tq_read action
                        on publisher-1l1007802'
                      type: Access Permission Denied
              schema:
                properties:
                  error:
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                    type: object
                type: object
          description: Unauthorized
      tags:
      - Transaction Queries
      description: 'Create one or more Transaction Queries. The fields required depends
        on the type of TQ being created: - Untracked: conversion_reference, camref,
        conversion_value, expected_commission, conversion_date_time - Incorrect commission:
        conversion_reference, camref, expected_commission - Declined: conversion_reference,
        camref'
      operationId: Create Transaction Queries
      requestBody:
        content:
          application/json:
            schema:
              example:
                transaction_queries:
                - camref: hrDu67
                  conversion_currency: GBP
                  conversion_date_time: 2017-01-01 00:00
                  conversion_reference: AF222PO
                  conversion_value: 67.12
                  expected_commission: 6.71
                  notes: Sample note
                  publisher_reference: A200FG1
                  transaction_query_type: untracked
              properties:
                transaction_queries:
                  type: array
              type: object
      summary: Create Transaction Queries
  /user/publisher/{publisher_id}/tq/{transaction_query_id}/delete:
    post:
      parameters:
      - 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: 1.16076 seconds
                    transaction_query:
                      deleted: true
              schema:
                properties:
                  execution_time:
                    type: string
                  transaction_query:
                    properties:
                      deleted:
                        type: boolean
                    type: object
                type: object
          description: OK
        '401':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    error:
                      message: 'Permission Denied: User cannot perform tq_read action
                        on publisher-1l1007802'
                      type: Access Permission Denied
              schema:
                properties:
                  error:
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                    type: object
                type: object
          description: Unauthorized
        '404':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    error:
                      message: Transaction Query could not be found; possibly because
                        it does not exist. Please check your selection and try again.
                      type: '404'
              schema:
                properties:
                  error:
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                    type: object
                type: object
          description: Not Found
        '405':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    error:
                      message: You cannot remove a Transaction Query that has been
                        changed to Approved or Rejected.
                      type: '405'
              schema:
                properties:
                  error:
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                    type: object
                type: object
          description: Method Not Allowed
      tags:
      - Transaction Queries
      description: Delete a single Transaction Query. Once a Transaction Query has
        been approved or rejected it cannot be deleted.
      operationId: Delete a Transaction Query
      summary: Delete a Transaction Query
  /user/publisher/{publisher_id}/selfbill:
    get:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_id
        required: true
        schema:
          type: string
      - description: Selfbill created from start date
        example: '2020-02-19 14:29:33'
        in: query
        name: start_date
        required: false
        schema:
          type: string
      - description: Selfbill created till end date
        example: '2020-02-19 17:29:33'
        in: query
        name: end_date
        required: false
        schema:
          type: string
      - description: Tracked currency
        example: GBP
        in: query
        name: currency
        required: false
        schema:
          type: string
      - description: Payment status
        example: created
        in: query
        name: status
        required: false
        schema:
          type: string
      - description: Payment paid from start date
        example: '2020-02-19 14:29:33'
        in: query
        name: payment_start_date
        required: false
        schema:
          type: string
      - description: Payment paid till end date
        example: '2020-02-19 17:29:33'
        in: query
        name: payment_end_date
        required: false
        schema:
          type: string
      - description: Paid currency
        example: GBP
        in: query
        name: paid_currency
        required: false
        schema:
          type: string
      - description: Selfbill currency
        example: GBP
        in: query
        name: selfbill_currency
        required: false
        schema:
          type: string
      - description: Field to sort the results by
        example: paid_currency
        in: query
        name: order
        required: false
        schema:
          type: string
      - description: Direction to sort the results by
        example: ASC
        in: query
        name: order_dir
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    selfbills:
                    - selfbill:
                        creation_date: '2012-07-25 14:22:35'
                        download: null
                        item_download: null
                        items_in_bill: 5
                        legal_entity: GB
                        majority_received_currency: GBP
                        net_value: 430.17
                        paid_currency: GBP
                        payment_batch_id: null
                        payment_date: null
                        payment_detail_set_id: 24
                        publisher_id: 1l1007802
                        publisher_payment_detail_set_id: 111111l80
                        publisher_self_bill_id: 1011l5403
                        publisher_self_bill_reference: null
                        self_bill_reference: S-1l1007802-1011l5403
                        selfbill_currency: GBP
                        status: created
                        timestamp: '2012-07-25 14:22:35'
                        total_value: 430.17
                        tracked_currency: GBP
                        tracked_net_value: 430.17
                        vat_rate: 0
                        vat_value: 0
                        withheld_tax: 0
              schema:
                properties:
                  selfbills:
                    items:
                      $ref: '#/components/schemas/Selfbill'
                    type: array
                type: object
          description: OK
      tags:
      - Self-billing
      description: View all Self-billing invoices that have been created for the partner.
      operationId: List all Selfbills
      summary: List all Selfbills
  /user/publisher/{publisher_id}/selfbill/{publisher_self_bill_id}:
    get:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_id
        required: true
        schema:
          type: string
      - description: ''
        example: 1011l5403
        in: path
        name: publisher_self_bill_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    selfbill:
                      creation_date: '2012-07-25 14:22:35'
                      download: null
                      item_download: null
                      items_in_bill: 5
                      legal_entity: GB
                      majority_received_currency: GBP
                      net_value: 430.17
                      paid_currency: GBP
                      payment_batch_id: null
                      payment_date: null
                      payment_detail_set_id: 24
                      publisher_id: 1l1007802
                      publisher_payment_detail_set_id: 111111l80
                      publisher_self_bill_id: 1011l5403
                      publisher_self_bill_reference: null
                      self_bill_reference: S-1l1007802-1011l5403
                      selfbill_currency: GBP
                      status: created
                      timestamp: '2012-07-25 14:22:35'
                      total_value: 430.17
                      tracked_currency: GBP
                      tracked_net_value: 430.17
                      vat_rate: 0
                      vat_value: 0
                      withheld_tax: 0
              schema:
                $ref: '#/components/schemas/Selfbill'
          description: OK
      tags:
      - Self-billing
      description: Retrieve an individual Self-billing invoice.
      operationId: Retrieve a Selfbill
      summary: Retrieve a Self-billing invoice.
  /user/publisher/{publisher_id}/payment_detail:
    get:
      parameters:
      - 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:
                    payment_details:
                      1011l22:
                        publisher_payment_detail_set_id: 1011l22
                        country: US
                        paid_currency: USD
                        tracked_currency:
                        - USD
                        payment_type_code: eft
                        payment_type_name: Electronic funds transfer
                        automatic_self_bill_creation_date: '-1'
                        automatic_self_bill_creation_threshold: '-1'
                        suspended: n
                        suspended_at: null
                        suspended_by: null
                        suspension_notes: null
                        payment_detail_values:
                          bank_address: 8th Floor, West One, Forth Banks
                          account_number: 12345678
                          account_name: joe bloggs
                          bank_name: bob bank
                          routing_number: 122105155
              schema:
                properties:
                  payment_details:
                    items:
                      $ref: '#/components/schemas/Payment_Details'
                    type: array
                type: object
          description: OK
      tags:
      - Payment Details
      description: View all Payment Details for a partner.
      operationId: List Payment Details
      summary: List Payment Details
    post:
      parameters:
      - 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:
                    payment_details:
                      1011l23:
                        publisher_payment_detail_set_id: 1011l23
                        country: US
                        paid_currency: USD
                        tracked_currency:
                        - USD
                        payment_type_code: eft
                        payment_type_name: Electronic funds transfer
                        automatic_self_bill_creation_date: '-1'
                        automatic_self_bill_creation_threshold: '-1'
                        suspended: n
                        suspended_at: null
                        suspended_by: null
                        suspension_notes: null
                        payment_detail_values:
                          bank_address: 8th Floor, West One, Forth Banks
                          account_number: 12345678
                          account_name: joe bloggs
                          bank_name: bob bank
                          routing_number: 122105155
              schema:
                properties:
                  payment_details:
                    items:
                      $ref: '#/components/schemas/Payment_Details'
                    type: array
                type: object
          description: OK
      tags:
      - Payment Details
      description: Create Payment Details for a partner.
      operationId: Create Payment Details
      requestBody:
        content:
          application/json:
            schema:
              example:
                payment_details:
                  1011l22:
                    publisher_payment_detail_set_id: 1011l22
                    country: US
                    paid_currency: USD
                    tracked_currency:
                    - USD
                    payment_type_code: eft
                    payment_type_name: Electronic funds transfer
                    automatic_self_bill_creation_date: '-1'
                    automatic_self_bill_creation_threshold: '-1'
                    suspended: n
                    suspended_at: null
                    suspended_by: null
                    suspension_notes: null
                    payment_detail_values:
                      bank_address: 8th Floor, West One, Forth Banks
                      account_number: 12345678
                      account_name: joe bloggs
                      bank_name: bob bank
                      routing_number: 122105155
              properties:
                payment_details:
                  items:
                    properties:
                      1011l22:
                        description: Dynamic property name equal to the payment details
                          set id. Must be active. Example - 1011l22
                        properties:
                          publisher_payment_detail_set_id:
                            type: string
                          payment_detail_values:
                            properties:
                              bank_address:
                                type: string
                              account_number:
                                type: number
                              account_name:
                                type: string
                              bank_name:
                                type: string
                              routing_number:
                                type: number
                            type: object
                        type: object
                  type: array
              type: object
      summary: Create Payment Details
  /user/publisher/{publisher_id}/available_commission:
    get:
      parameters:
      - 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:
                    available_commissions:
                      available_commission:
                        no_items: 1
                        value: 568
                        publisher_commission: 312.4
                        currency: SGD
                        publisher_id: 1l1007802
                        publisher_commission_converted:
                          currency: USD
                          value: 228.88
              schema:
                properties:
                  available_commissions:
                    items:
                      properties:
                        no_items:
                          description: Number of items
                          type: number
                        value:
                          type: number
                        publisher_commission:
                          type: number
                        currency:
                          $ref: '#/components/schemas/Currency'
                        publisher_id:
                          type: string
                        publisher_commission_converted:
                          properties:
                            currency:
                              $ref: '#/components/schemas/Currency'
                            value:
                              type: number
                          type: object
                    type: array
                type: object
          description: OK
      tags:
      - Available Commission
      description: Retrieve the available commission for a given partner.
      operationId: Retrieve Available Commission
      summary: Retrieve Available Commission
  /user/publisher/{publisher_id}/payment/summary:
    get:
      parameters:
      - 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:
                    execution_time: 2.25885 seconds
                    summary:
                      available:
                        CAD: 12.45
                        AUD: 0.4
                      confirmed:
                        EUR: 11
                        GBP: 54.2
                      pending:
                        EUR: 125.11
                        GBP: 57.65
                        JPY: 97
                      approved:
                        GBP: 90.8
                        USD: 100.23
                      paid:
                        PLN: 68.96
              schema:
                $ref: '#/components/schemas/Partner_Payment_Summary'
          description: OK
      tags:
      - Summary
      description: Return the details of partner's pending (shows value of pending
        conversions), approved (shows value of approved conversions), confirmed (amount
        that will be available once brand's invoice is paid), available (amount of
        money available to withdraw in this moment), and paid (already withdrawn)
        funds.
      operationId: Partner payments summary
      summary: Summarise value of partner's conversions
  /v2/publishers//links:
    get:
      parameters:
      - 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:
                    execution_time: 0.29440 seconds
                    count: 2
                    limit: 200
                    offset: 0
                    links:
                    - id: 1011l10
                      campaign_id: 4d36c720be593
                      description: null
                      destination_url: http://test.com
                      tracking_short_url: https://staging.prf.hn/l/bKVPQEz
                      tracking_url: https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com
                      params:
                      - key: pubref
                        value: fdghjdkf
                      active: true
                    - id: 1011l18
                      campaign_id: '300045'
                      description: null
                      destination_url: http://dfdff
                      tracking_short_url: https://staging.prf.hn/l/GE082EL
                      tracking_url: https://staging.prf.hn/click/camref:i995/pubref:fdfdf/adref:dfdff/destination:http://dfdff
                      params:
                      - key: pubref
                        value: fdfdf
                      - key: adref
                        value: dfdff
                      active: true
                    hypermedia:
                      pagination:
                        total_page_count: 1
                        total_item_count: 1
                        first_page: /v2/publishers/2/links?limit=200&offset=0
                        last_page: /v2/publishers/2/links?limit=200&offset=0
                        next_page: null
                        previous_page: null
              schema:
                properties:
                  links:
                    items:
                      $ref: '#/components/schemas/Link'
                    type: array
                type: object
          description: OK
      tags:
      - Tracking Links
      description: Retrieve tracking links for a given partner. Note, these will only
        be short links.
      operationId: Retrieve Tracking Links
      summary: Retrieve Tracking Links
    post:
      parameters:
      - 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:
                    execution_time: 0.29440 seconds
                    link:
                      id: 1011l10
                      campaign_id: 4d36c720be593
                      description: null
                      destination_url: http://test.com
                      tracking_short_url: https://staging.prf.hn/l/bKVPQEz
                      tracking_url: https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com
                      params:
                      - key: pubref
                        value: fdghjdkf
                      active: true
              schema:
                properties:
                  link:
                    $ref: '#/components/schemas/Link'
          description: OK
      tags:
      - Tracking Links
      description: Create tracking links for a given partner and campaign.
      operationId: Create Tracking Links
      requestBody:
        content:
          application/json:
            example:
              campaign_id: 4d36c720be593
              description: null
              destination_url: http://test.com
              params:
              - key: pubref
                value: fdghjdkf
              active: true
            schema:
              properties:
                campaign_id:
                  type: string
                description:
                  type: string
                destination_url:
                  type: string
                params:
                  items:
                    $ref: '#/components/schemas/Key_Value_Pair'
                active:
                  type: boolean
              required:
              - campaign_id
              type: object
      summary: Create a Tracking Link
  /v2/publishers//links/:
    get:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_id
        required: true
        schema:
          type: string
      - description: ID of the tracking link
        example: 1011l10
        in: path
        name: link_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    execution_time: 0.29440 seconds
                    link:
                      id: 1011l10
                      campaign_id: 4d36c720be593
                      description: null
                      destination_url: http://test.com
                      tracking_short_url: https://staging.prf.hn/l/bKVPQEz
                      tracking_url: https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com
                      params:
                      - key: pubref
                        value: fdghjdkf
                      active: true
              schema:
                properties:
                  link:
                    $ref: '#/components/schemas/Link'
                type: object
          description: OK
      tags:
      - Tracking Links
      description: Retrieve a tracking link.
      operationId: Retrieve a Tracking Link
      summary: Retrieve a Tracking Link
    patch:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_id
        required: true
        schema:
          type: string
      - description: ID of the tracking link
        example: 1011l10
        in: path
        name: link_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    execution_time: 0.29440 seconds
                    link:
                      id: 1011l10
                      campaign_id: 4d36c720be593
                      description: test
                      destination_url: http://test.com
                      tracking_short_url: https://staging.prf.hn/l/bKVPQEz
                      tracking_url: https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com
                      params:
                      - key: pubref
                        value: fdghjdkf
                      active: true
              schema:
                properties:
                  link:
                    $ref: '#/components/schemas/Link'
                type: object
          description: OK
      tags:
      - Tracking Links
      description: Update a tracking link.
      operationId: Update a Tracking Link
      requestBody:
        content:
          application/json:
            example:
              campaign_id: 4d36c720be593
              description: test
              destination_url: http://test.com
              params:
              - key: pubref
                value: fdghjdkf
              active: true
            schema:
              properties:
                campaign_id:
                  type: string
                description:
                  type: string
                destination_url:
                  type: string
                params:
                  items:
                    $ref: '#/components/schemas/Key_Value_Pair'
                active:
                  type: boolean
              type: object
      summary: Update a Tracking Link
  /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/default:
    get:
      operationId: get-publisher-commissions-default
      tags:
      - Commissions
      summary: Get 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:
      - 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:
                          title: Commission Status
                          description: These values are internally managed and represent
                            the statue of the Commission
                          type: string
                          enum:
                          - ACTIVE
                          - RETIRED
                          - DELETED
                          - SCHEDULED
                        meta_fields:
                          type: array
                          items:
                            title: Meta Field Rules
                            allOf:
                            - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1active/get/responses/200/content/application~1json/schema/properties/active_commissions/items/anyOf/1/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/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1campaign/get/responses/200/content/application~1json/schema/properties/commissions/items/properties/meta_fields/items/allOf/1/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
                        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:
      - Voucher 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~1publishers~1%7BpublisherId%7D~1commissions~1campaign/get/responses/200/content/application~1json/schema/properties/commissions/items/properties/status'
                        meta_fields:
                          type: array
                          minItems: 0
                          items:
                            type: object
                            title: Meta Field Value
                            description: Meta Field with an assigned value
                            allOf:
                            - type: object
                              title: Meta Field
                              properties:
                                name:
                                  type: string
                                  description: The name of the meta field
                                  example: category
                              required:
                              - name
                            - properties:
                                value:
                                  description: The value of meta field to look for
                              required:
                              - value
                        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~1publishers~1%7BpublisherId%7D~1commissions~1tier/get/responses/200/content/application~1json/schema/properties/tiers/items/properties/groups/items'
                        commission_based_on_field:
                          type: string
  /v2/campaigns/{campaignId}/publishers/{publisherId}/commissions/promotion:
    get:
      operationId: get-publisher-commissions-promotion
      tags:
      - Promotional 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~1publishers~1%7BpublisherId%7D~1commissions~1campaign/get/responses/200/content/application~1json/schema/properties/commissions/items/properties/status'
                        meta_fields:
                          type: array
                          items:
                            $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1campaign/get/responses/200/content/application~1json/schema/properties/commissions/items/properties/meta_fields/items'
                        publishers:
                          type: array
                          minItems: 0
                          items:
                            $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1tier/get/responses/200/content/application~1json/schema/properties/tiers/items/properties/publishers/items'
                        groups:
                          type: array
                          minItems: 0
                          items:
                            $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1tier/get/responses/200/content/application~1json/schema/properties/tiers/items/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:
      - Tiered 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:
                      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: Which approval statuses to reward
                        reward_model:
                          allOf:
                          - title: Reward Model
                            description: Model used to calculate Partner rewards
                            type: string
                            enum:
                            - fixed_reward
                            - fixed_cpa
                            - percentage_cpa
                        performance_measurement:
                          allOf:
                          - title: Performance Measurement
                            description: The measurement used to calculate Partners
                              performance
                            type: string
                            enum:
                            - total_items
                            - total_revenue
                        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~1publishers~1%7BpublisherId%7D~1commissions~1voucher/get/responses/200/content/application~1json/schema/properties/voucher_commissions/items/properties/meta_fields/items/allOf/0'
                              - type: object
                                properties:
                                  weight:
                                    type: number
                                    description: The weight of the meta field
                                required:
                                - weight
                            - $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1campaign/get/responses/200/content/application~1json/schema/properties/commissions/items/properties/meta_fields/items'
                        levels:
                          type: array
                          minItems: 1
                          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: 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}/publishers/{publisherId}/commissions/active:
    get:
      operationId: get-active-publisher-commissions
      tags:
      - 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:
                            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
                            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~1publishers~1%7BpublisherId%7D~1commissions~1campaign/get/responses/200/content/application~1json/schema/properties/commissions/items/properties/status'
                          meta_fields:
                            type: array
                            items:
                              $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1campaign/get/responses/200/content/application~1json/schema/properties/commissions/items/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: 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:
                                  title: Performance Model
                                  description: Model used to calculate Partner commission
                                  type: string
                                  enum:
                                  - fixed_cpa
                                  - percentage_cpa
                                  - cpc
                                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
                      - 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~1publishers~1%7BpublisherId%7D~1commissions~1tier/get/responses/200/content/application~1json/schema/properties/tiers/items/properties/reward_model/allOf/0'
                          performance_measurement:
                            $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1tier/get/responses/200/content/application~1json/schema/properties/tiers/items/properties/performance_measurement/allOf/0'
                          status:
                            $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1tier/get/responses/200/content/application~1json/schema/properties/tiers/items/properties/status'
                          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~1publishers~1%7BpublisherId%7D~1commissions~1voucher/get/responses/200/content/application~1json/schema/properties/voucher_commissions/items/properties/meta_fields/items/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
                          levels:
                            type: array
                            minItems: 1
                            description: An array of Commission Tier Levels.
                            items:
                              $ref: '#/paths/~1v2~1campaigns~1%7BcampaignId%7D~1publishers~1%7BpublisherId%7D~1commissions~1tier/get/responses/200/content/application~1json/schema/properties/tiers/items/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}/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
  /user/publisher/{publisherId}/commission_group:
    get:
      operationId: get-partner-commission-groups
      tags:
      - Commission Groups (v1)
      summary: List Partner Commission Groups
      description: 'This endpoint lists all commission groups for a partner.

        '
      parameters:
      - in: path
        name: publisherId
        description: The ID of a Partner
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Commission Groups List
          content:
            application/json:
              examples:
                response:
                  value:
                    count: 2
                    execution_time: 0.02571 seconds
                    commission_groups:
                    - commission_group:
                        commission_group_id: 1011l1
                        campaign_id: 1
                        name: The_group
                        description: ''
                        start_date_time: '2018-11-01 12:00:00'
                      end_date_time: null
                      active: y
                      last_modified: '2018-11-29 14:57:05'
                    - commission_group:
                        commission_group_id: 1011l16
                        campaign_id: 300659
                        name: Blog
                        description: ''
                        start_date_time: '2019-06-03 11:00:00'
                      end_date_time: null
                      active: n
                      last_modified: '2019-07-29 11:03:32'
              schema:
                properties:
                  count:
                    type: number
                  execution_time:
                    type: string
                  commission_groups:
                    items:
                      properties:
                        commission_group:
                          properties:
                            commission_group_id:
                              description: the Id of the commission group
                              type: string
                            campaign_id:
                              description: the Id of the campaign
                              type: string
                            name:
                              description: the name of the campaign group
                              type: string
                            description:
                              type: string
                            start_date_time:
                              type: string
                            end_date_time:
                              type: string
                            active:
                              $ref: '#/components/schemas/YesOrNo'
                            last_modified:
                              type: string
                          type: object
                      type: object
                    type: array
                type: object
  /v2/publishers/{publisherId}/discovery/advertisers:
    get:
      parameters:
      - name: publisherId
        in: path
        description: ID of the partner
        examples:
        - 1l1007802
        required: true
        schema:
          type: string
      operationId: getBrands
      tags:
      - Brand Discovery (v2)
      summary: List Brands & Campaigns
      description: 'Returns all campaigns available for a partner to join, grouped
        by brand.

        Each campaign will include a `status:` for the partner:-

        * AVAILABLE

        * REQUESTED

        * INVITED

        * REJECTED

        '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-04/schema
                type: object
                title: Advertisers
                properties:
                  advertisers:
                    type: array
                    items:
                      allOf:
                      - $ref: '#/paths/~1v2~1publishers~1%7BpublisherId%7D~1discovery~1advertisers~1%7BadvertiserId%7D/get/responses/200/content/application~1json/schema/properties/advertiser/allOf/0'
                      - properties:
                          campaigns:
                            type: array
                            title: Campaign
                            items:
                              $schema: http://json-schema.org/draft-04/schema
                              type: object
                              properties:
                                id:
                                  type: string
                                default_destination:
                                  type: string
                                  nullable: true
                                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: £
                                vertical:
                                  $schema: http://json-schema.org/draft-04/schema
                                  title: Vertical
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: '1'
                                    name:
                                      type: string
                                      example: Retail
                                status:
                                  enum:
                                  - AVAILABLE
                                  - REQUESTED
                                  - INVITED
                                  - REJECTED
                additionalProperties: false
  /v2/publishers/{publisherId}/discovery/advertisers/{advertiserId}:
    get:
      parameters:
      - name: publisherId
        in: path
        description: ID of the partner
        examples:
        - 1l1007802
        required: true
        schema:
          type: string
      - name: advertiserId
        in: path
        description: ID of the brand
        examples:
        - 1l1007802
        required: true
        schema:
          type: string
      operationId: getBrand
      tags:
      - Brand Discovery (v2)
      summary: Retrieve a Brand
      description: 'Returns one advertiser with a list of campaigns availabe for a
        partner to join.

        Each campaign will include a `status:` for the partner:-

        * AVAILABLE

        * REQUESTED

        * INVITED

        * REJECTED

        '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-04/schema
                type: object
                title: Advertiser
                properties:
                  advertiser:
                    allOf:
                    - $schema: http://json-schema.org/draft-04/schema#
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        display_name:
                          type: string
                        contact_email:
                          type: string
                          nullable: true
                        description:
                          type: string
                          nullable: true
                        advertiser_icon:
                          type: string
                          nullable: true
                        network:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                        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
                    - properties:
                        campaigns:
                          type: array
                          title: Campaign
                          items:
                            allOf:
                            - $ref: '#/paths/~1v2~1publishers~1%7BpublisherId%7D~1discovery~1advertisers/get/responses/200/content/application~1json/schema/properties/advertisers/items/allOf/1/properties/campaigns/items'
                            - properties:
                                campaign_icon:
                                  type: string
                                  nullable: true
                additionalProperties: false
  /v2/publishers/{publisher_id}/invitations/advertisers/:
    get:
      parameters:
      - 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:
                    advertisers:
                    - address:
                        country: Chile
                        line1: 123 Super street
                        line2: ''
                        line3: Super city
                        line4: ''
                        postcode: SU5 PER
                      id: '301284'
                      invitations:
                      - campaign:
                          currency:
                            iso: CLP
                            name: Chilean peso
                            symbol: $
                          default_destination: https://mysuperdefaultdestination.com
                          id: '300866'
                          campaign_logo: https://path/to/campaign/logo.png
                          title: My that is a super campaign
                          vertical:
                            id: '131'
                            name: boats
                        id: 11111|1
                      name: Super brand
                      network:
                        id: 111111l300118
                        name: Super nework
                    count: 1
                    execution_time: 0.98709 seconds
              schema:
                additionalProperties: false
                properties:
                  advertisers:
                    items:
                      properties:
                        address:
                          properties:
                            country:
                              $ref: '#/components/schemas/Country'
                            line1:
                              type: string
                            line2:
                              type: string
                            line3:
                              type: string
                            line4:
                              type: string
                            postcode:
                              type: string
                          type: object
                        id:
                          type: string
                        invitations:
                          items:
                            properties:
                              campaign:
                                properties:
                                  currency:
                                    properties:
                                      iso:
                                        type: string
                                      name:
                                        type: string
                                      symbol:
                                        type: string
                                    type: object
                                  campaign_logo:
                                    type: string
                                  default_destination:
                                    type: string
                                  id:
                                    type: string
                                  title:
                                    type: string
                                  vertical:
                                    properties:
                                      id:
                                        type: string
                                      name:
                                        type: string
                                    type: object
                                type: object
                              id:
                                type: string
                            type: object
                          type: array
                        name:
                          type: string
                        network:
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                          type: object
                      type: object
                    type: array
                  count:
                    type: number
                  execution_time:
                    type: string
                required:
                - execution_time
                - count
                - advertisers
                type: object
          description: OK
      tags:
      - Campaign Invitations (v2)
      description: See all invites available to a partner grouped by brand
      operationId: List Invitations
      summary: List Invitations
  /v2/publishers/{publisherId}/invitations/accept:
    post:
      parameters:
      - name: publisherId
        in: path
        description: ID of the partner
        examples:
        - 1l1007802
        required: true
        schema:
          type: string
      operationId: acceptInvitations
      tags:
      - Campaign Invitations (v2)
      summary: Accept Campaign Invitiations
      description: 'Allows a partner to accept one of many of their invitations.

        '
      requestBody:
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-04/schema#
              type: object
              properties:
                campaign_ids:
                  type: array
                  description: Campaign IDs to which the Partner has been invited
                  items:
                    type: string
              required:
              - campaign_ids
            example:
              campaign_ids:
              - 111111l300140
              - 111111l400044
      responses:
        '204':
          description: Success
  /v2/publishers/{publisherId}/invitations/decline:
    post:
      parameters:
      - name: publisherId
        in: path
        description: ID of the partner
        examples:
        - 1l1007802
        required: true
        schema:
          type: string
      operationId: declineInvitations
      tags:
      - Campaign Invitations (v2)
      summary: Decline Campaign Invitiations
      description: 'Allows a partner to decline one of many of their invitations.

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/paths/~1v2~1publishers~1%7BpublisherId%7D~1invitations~1accept/post/requestBody/content/application~1json/schema'
            example:
              campaign_ids:
              - 111111l300140
              - 111111l400044
      responses:
        '204':
          description: Success
  /v2/publishers/{publisherId}/campaign-requests:
    post:
      parameters:
      - name: publisherId
        in: path
        description: ID of the partner
        examples:
        - 1l1007802
        required: true
        schema:
          type: string
      operationId: createCampaignRequests
      tags:
      - Campaign Requests (v2)
      summary: Create Campaign Requests
      description: 'Allows a partner to make requests to join campaigns.

        '
      requestBody:
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-04/schema#
              type: object
              properties:
                campaign_requests:
                  type: array
                  items:
                    type: object
                    properties:
                      advertiser_id:
                        type: string
                        example: 111111l1
                      campaign_id:
                        type: string
                        example: 111111l1
                    required:
                    - advertiser_id
                    - campaign_id
              required:
              - campaign_requests
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-04/schema#
                type: object
                properties:
                  success_count:
                    type: integer
                    example: 1
                  failure_count:
                    type: integer
                    example: 0
                  execution_type:
                    type: string
                    example: 0.34642 seconds
  /v2/publishers/{publisherId}/campaigns/terms?campaigns={campaigns}:
    get:
      parameters:
      - name: publisherId
        in: path
        description: ID of the partner
        examples:
        - 1l1007802
        required: true
        schema:
          type: string
      - name: campaigns
        in: query
        description: comma seperated list of Campaign IDs
        examples:
        - 1lCAMA001,1lCAMB002
        required: true
        schema:
          type: array
          operationId: combined-campaign-terms
      summary: List Terms and Conditions (v2)
      tags:
      - Terms and Conditions
      description: 'View combined terms & conditions for the given Campaigns(s) and
        Network(s). If a partner has custom campaign terms, these will be shown in
        place of the standard campaign terms. Terms content for

        standard campaign and network terms is return as HTML. For campaign custom
        partner terms, the content is returned as JSON which can be parsed and rendered
        to HTML using the [Slate](https://docs.slatejs.org) framework.

        '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-04/schema#
                type: object
                title: Publisher Combined Campaign Terms Response
                required:
                - count
                - terms
                properties:
                  count:
                    $id: '#/properties/count'
                    type: integer
                    examples:
                    - 2
                  terms:
                    $id: '#/properties/terms'
                    type: array
                    title: Combined terms
                    items:
                      $id: '#/properties/terms/items'
                      type: object
                      required:
                      - title
                      - content
                      properties:
                        title:
                          $id: '#/properties/terms/items/properties/title'
                          type: string
                        content:
                          $id: '#/properties/terms/items/properties/content'
                          type: string
              example:
                count: 3
                terms:
                - title: Network terms
                  content: 
      Hostels.com operates a closed and strict keyword policy.
                    Affiliates are unable to participate in specific PPC activity
                    to drive traffic directly to Hostels.com on Google, Yahoo or Bing
                    search engines.
      
                - title: Campaign A standard terms
                  content: 
      There is a maximum cap of 2 units per order on new phone
                    and 5 units per order for all other products. Commissions will
                    not be paid on units exceeding this cap.
      
                - title: Partner custom terms for Campaign B
                  content:
                    object: value
                    document:
                      object: document
                      data: {}
                      nodes:
                      - object: block
                        type: paragraph
                        data: {}
                        nodes:
                        - object: text
                          leaves:
                          - object: leaf
                            text: Custom campaign terms for Publisher Y
                            marks: []
  /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
  /reporting/report_publisher/publisher/{publisher_id}/conversion.{format}:
    get:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_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_updated` or `approved_at` the response will
          only include conversions that were last modified or approved at in approved_at
          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[campaign][]=111111l29.
          Supported values are: `campaign`, `product`, `publisher_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
      - description: Invoices that were created after the supplied date.
        example: '2016-03-10T19:02:35Z'
        in: query
        name: invoice_created_date
        required: false
        schema:
          type: string
      - description: 'Include payment information. Omit parameter or false to exclude,
          which is the default. Fields included are:

          + payment_status

          + self_bill_request_date

          + self_bill_release_date'
        example: true
        in: query
        name: include_payment_info
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    total_conversion_count:
                      EUR: 1
                    total_publisher_commission:
                      EUR: 95.5
                    total_value:
                      EUR: 955
                    start_date_time_utc: '2019-08-10 00:00:00'
                    end_date_time_utc: '2020-03-10 00:00:00'
                    start_date_time: '2020-03-08 17:18:33'
                    end_date_time: '2020-03-08 17:18:33'
                    limit: 300
                    meta_data: []
                    count: 1
                    execution_time: 1.04266 seconds
                    conversions:
                    - conversion_data:
                        conversion_id: 111111l314
                        campaign_id: 111111l29
                        publisher_id: 111111l92
                        conversion_time: '2020-03-08 17:18:33'
                        creative_type: 0
                        creative_id: 0
                        specific_creative_id: 0
                        currency: EUR
                        publisher_reference: ''
                        advertiser_reference: adrefd
                        conversion_reference: AUTO-5ebc127cb2ddf3.85382959
                        customer_type: null
                        referer_ip: 265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1
                        source_referer: ''
                        last_modified: '2020-05-13 15:31:42'
                        conversion_type: 1
                        country: ES
                        customer_reference: custrefa
                        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: rubycampaignsuvwlynm
                        publisher_name: syjmmcll
                        click:
                          campaign_id: 111111l29
                          publisher_id: 111111l92
                          type: standard
                          status: nibbled
                          set_time: '2020-03-08 17:18:33'
                          set_ip: 265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1
                          last_used: 1589383804
                          last_ip: 265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1
                          publisher_reference: ''
                          referer: ''
                          creative_id: 0
                          creative_type: 0
                          specific_creative_id: 0
                          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: 111111lfo
                        ref_conversion_metric: Standard
                        ref_device: Desktop
                        ref_partnership_model: CPA
                        ref_traffic_source: Affiliate
                        ref_user_context: Web
                        conversion_value:
                          conversion_status: pending
                          value: 955
                          publisher_commission: 95.5
                        meta_data:
                          gclid: adword_google_meta_data
                        conversion_items:
                        - conversion_item_id: 111111l314
                          sku: 123
                          category: Producte
                          item_value: 955
                          item_publisher_commission: 95.5
                          item_status: pending
                          last_update: '2020-05-13 15:30:04'
                          publisher_self_bill_id: null
                          approved_at: null
                          item_status_id: 1
                          reject_reason: null
                          voucher_codes: []
                          meta_data:
                            gclid: adword_google_meta_data
                          payable: false
                        was_disputed: false
                        conversion_lag: 0
                        clickref: 111111lfo
              schema:
                $ref: '#/components/schemas/Partner_Conversions'
          description: OK
      tags:
      - Partner Conversions
      description: Return a mix of aggregated and basket/item level conversion data
        for a partner.
      operationId: partner-conversions
      summary: Retrieve a Partner Conversions Report
  /reporting/report_publisher/publisher/{publisher_id}/click.{format}:
    get:
      parameters:
      - description: ID of the partner
        example: 1l1007802
        in: path
        name: publisher_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_updated` or `approved_at` the response will
          only include conversions that were last modified or approved at in approved_at
          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[campaign][]=111111l29.
          Supported values are: `campaign`, `publisher_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: '2020-03-10 00:00:00'
                    start_date_time: '2020-03-08 17:18:33'
                    end_date_time: '2020-03-09 14:27:15'
                    limit: 300
                    offset: 0
                    count: 2
                    execution_time: 0.27682 seconds
                    clicks:
                    - click:
                        campaign_id: 111111l29
                        publisher_id: 111111l92
                        type: standard
                        status: nibbled
                        set_time: '2020-03-08 17:18:33'
                        set_ip: 265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1
                        last_used: '2020-05-13 15:30:04'
                        last_ip: 265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1
                        publisher_reference: ''
                        referer: ''
                        creative_id: 0
                        creative_type: 0
                        specific_creative_id: 0
                        ref_device_id: 2
                        ref_traffic_source_id: 3
                        ref_partnership_model_id: 2
                        ref_user_context_id: 2
                        clickref: 111111lfo
                        meta_data: []
                    - click:
                        campaign_id: 111111l29
                        publisher_id: 111111l92
                        type: standard
                        status: nibbled
                        set_time: '2020-03-09 14:27:15'
                        set_ip: 265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1
                        last_used: '2020-05-13 15:30:18'
                        last_ip: 265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1
                        publisher_reference: ''
                        referer: ''
                        creative_id: 0
                        creative_type: 0
                        specific_creative_id: 0
                        ref_device_id: 2
                        ref_traffic_source_id: 3
                        ref_partnership_model_id: 2
                        ref_user_context_id: 2
                        clickref: 111111lfq
                        meta_data: []
              schema:
                $ref: '#/components/schemas/Partner_Clicks'
          description: OK
      tags:
      - Partner Clicks
      description: Return a mix of aggregated and basket/item level click data for
        a partner.
      operationId: partner-clicks
      summary: Retrieve a Partner Clicks Report
  /reporting/report_publisher/publisher/{publisher_id}/payable:
    get:
      parameters:
      - 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:
                    offset: 0
                    limit: 300
                    count: 0
                    total_conversion_count:
                      EUR: 1
                      GBP: 6
                      USD: 1
                    total_commission_value:
                      EUR: 44
                      GBP: 342.3365
                      USD: 44
                    total_value:
                      EUR: 400
                      GBP: 3112.15
                      USD: 400
                    total_publisher_commission_value:
                      EUR: 40
                      GBP: 311.215
                      USD: 40
                    execution_time: 0.55225 seconds
                    conversion_items: []
              schema:
                additionalProperties: false
                properties:
                  count:
                    type: number
                  execution_time:
                    type: string
                  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_value:
                    description: 'total 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
                  conversion_items:
                    items: {}
                    type: array
          description: OK
      tags:
      - Partner Payable
      description: Return the aggregation stats of payable commission for a particular
        partner.
      operationId: partner-payable
      summary: Retrieve a Partner Payable Report
  /reporting/export/export/click.csv:
    get:
      parameters:
      - description: ID of the partner.
        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 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 partner.
        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 beased 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 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 partner.
        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 beased 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

          + self_bill_request_date

          + self_bill_release_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 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
  /v3/partner/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~1partner~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/interval/properties/field'
                comparison_date_time_ranges:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  description: Filter data by a specified partner identifier. You
                    must have the correct authorisation to view reporting data on
                    this partner.
                  type: object
                  required:
                  - partner
                  properties:
                    partner:
                      type: string
                  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
                          - device_id
                          - os_family
                          - os_major
                          - os_minor
                          - os_patch
                          - partner_id
                          - partner_name
                          - publisher_reference
                          - 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:
                partner: 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/partner/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~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                comparison_date_time_ranges:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/metrics'
                group_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/group_by'
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                order_by:
                  $ref: '#/paths/~1v3~1partner~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~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top'
                include_total_row_count:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count'
                timezone:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone'
                include_comparison_percentage_change:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 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~1partner~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count'
  /v3/partner/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~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~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
                      - publisher_reference
                      - partnership_model
                      - traffic_source
                      - type
                      - user_context
                filter_by:
                  $ref: '#/paths/~1v3~1partner~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
                          - publisher_reference
                          - 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~1partner~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:
                partner: 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/partner/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~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/metrics'
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                interval:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/interval'
                timezone:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 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/partner/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~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges/allOf/0'
                  - items:
                      properties:
                        field:
                          $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1explode/post/requestBody/content/application~1json/schema/properties/interval/properties/field'
                comparison_date_time_ranges:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/metrics/allOf/0'
                  - items:
                      type: string
                      enum:
                      - total_conversion_items
                      - total_conversions
                      - total_partner_commission
                      - percentage_average_partner_commission
                      - average_order_value
                      - total_order_value
                      - conversion_rejection_rate
                      - average_order_size
                      - percentage_order_value
                      - percentage_partner_commission
                      - average_partner_commission
                filter_by:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by/allOf/0'
                  - items:
                      properties:
                        field:
                          type: string
                          enum:
                          - partner_commission
                          - order_value
                          - advertiser_reference
                          - browser_family
                          - browser_major
                          - browser_minor
                          - browser_patch
                          - campaign_id
                          - campaign_name
                          - category
                          - conversion_metric_id
                          - conversion_status
                          - conversion_type_id
                          - country
                          - creative_id
                          - creative_description
                          - creative_advertiser_reference
                          - currency
                          - customer_type
                          - device_id
                          - os_family
                          - os_major
                          - os_minor
                          - os_patch
                          - partner_id
                          - partner_name
                          - publisher_reference
                          - 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:
                            - 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~1partner~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~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone'
                include_comparison_percentage_change:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 111111l10
              metrics:
              - total_partner_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/partner/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~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                comparison_date_time_ranges:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/metrics'
                group_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1filter/post/requestBody/content/application~1json/schema/properties/group_by'
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                order_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1filter/post/requestBody/content/application~1json/schema/properties/order_by'
                interval:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~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~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/output_currency'
                output_date_time_format:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/output_date_time_format'
                top:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top'
                include_total_row_count:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count'
                timezone:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone'
                include_comparison_percentage_change:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 111111l10
              metrics:
              - total_partner_commission
              group_by:
              - country
              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~1partner~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count'
            X-Approximate-Metrics:
              $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/responses/200/headers/X-Approximate-Metrics'
  /v3/partner/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~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                group_by:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~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_status
                      - conversion_type
                      - country
                      - creative
                      - currency
                      - customer_type
                      - date_time
                      - device
                      - os_family
                      - os_major
                      - os_minor
                      - os_patch
                      - partner
                      - publisher_reference
                      - partnership_model
                      - sku
                      - traffic_source
                      - type
                      - user_context
                      - voucher_code
                      - voucher_status
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                order_by:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~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_partner_commission
                          - percentage_average_partner_commission
                          - total_order_value
                          - advertiser_reference
                          - average_order_value
                          - conversion_rejection_rate
                          - average_order_size
                          - browser_family
                          - browser_major
                          - browser_minor
                          - browser_patch
                          - campaign_id
                          - campaign_name
                          - category
                          - conversion_metric_id
                          - conversion_metric_name
                          - conversion_status
                          - conversion_type_id
                          - conversion_type_name
                          - country
                          - country_name
                          - creative_id
                          - creative_description
                          - creative_advertiser_reference
                          - currency
                          - customer_type
                          - date_time
                          - device_id
                          - device_name
                          - os_family
                          - os_major
                          - os_minor
                          - os_patch
                          - partner_id
                          - partner_name
                          - publisher_reference
                          - 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~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/output_currency'
                top:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top'
                include_total_row_count:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count'
                timezone:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 111111l10
              group_by:
              - country
              filter_by:
              - field: country
                value: US
                operator: EQUALS
              - field: device_id
                value: 5
                operator: EQUALS
                not: true
              order_by:
              - field: total_partner_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~1partner~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count'
            X-Approximate-Metrics:
              $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/responses/200/headers/X-Approximate-Metrics'
  /v3/partner/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~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/metrics'
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                interval:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1explode/post/requestBody/content/application~1json/schema/properties/interval'
                output_currency:
                  $ref: '#/paths/~1v3~1partner~1analytics~1conversions~1count/post/requestBody/content/application~1json/schema/properties/output_currency'
                timezone:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone'
                zerofill:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 111111l10
              metrics:
              - total_partner_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~1partner~1analytics~1conversions~1count/post/responses/200/headers/X-Approximate-Metrics'
  /v3/partner/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~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges/allOf/0'
                  - items:
                      properties:
                        field:
                          $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1explode/post/requestBody/content/application~1json/schema/properties/interval/properties/field'
                comparison_date_time_ranges:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~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~1partner~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
                          - device_id
                          - os_family
                          - os_major
                          - os_minor
                          - os_patch
                          - partner_id
                          - partner_name
                          - publisher_reference
                          - partnership_model_id
                          - traffic_source_id
                          - user_context_id
                        operator:
                          $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/filter_by/allOf/1/items/properties/operator'
                timezone:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone'
                include_comparison_percentage_change:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 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/partner/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~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                comparison_date_time_ranges:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/metrics'
                group_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1filter/post/requestBody/content/application~1json/schema/properties/group_by'
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                order_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1filter/post/requestBody/content/application~1json/schema/properties/order_by'
                interval:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~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~1partner~1analytics~1clicks~1explode/post/requestBody/content/application~1json/schema/properties/output_date_time_format'
                top:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top'
                include_total_row_count:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count'
                timezone:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone'
                include_comparison_percentage_change:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 111111l10
              metrics:
              - total_impressions
              group_by:
              - campaign
              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~1partner~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count'
  /v3/partner/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~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                group_by:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~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
                      - publisher_reference
                      - partnership_model
                      - traffic_source
                      - user_context
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                order_by:
                  allOf:
                  - $ref: '#/paths/~1v3~1partner~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
                          - publisher_reference
                          - partnership_model_id
                          - partnership_model_name
                          - traffic_source_id
                          - traffic_source_name
                          - user_context_id
                          - user_context_name
                top:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/top'
                include_total_row_count:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1filter/post/requestBody/content/application~1json/schema/properties/include_total_row_count'
                timezone:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 111111l10
              group_by:
              - campaign
              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~1partner~1analytics~1clicks~1filter/post/responses/200/headers/X-Total-Row-Count'
  /v3/partner/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~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/date_time_ranges'
                scope:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/scope'
                metrics:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/metrics'
                filter_by:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1count/post/requestBody/content/application~1json/schema/properties/filter_by'
                interval:
                  $ref: '#/paths/~1v3~1partner~1analytics~1impressions~1explode/post/requestBody/content/application~1json/schema/properties/interval'
                timezone:
                  $ref: '#/paths/~1v3~1partner~1analytics~1clicks~1count/post/requestBody/content/application~1json/schema/properties/timezone'
                zerofill:
                  $ref: '#/paths/~1v3~1partner~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:
                partner: 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
  /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/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/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/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 aquisition
                        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
  /v3/partner/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 partner to restrict scope of Partnerize Tags to
        example: 111111l8
        in: query
        name: partner_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 Partner
                    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:
                            partner:
                              type: string
                              description: Partner 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:
                          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~1partner~1partnerize-tags/post/responses/201/content/application~1json%3B%20charset%3Dutf-8/schema/properties/data/properties/created_at/definitions/date-time'
                                end:
                                  $ref: '#/paths/~1v3~1partner~1partnerize-tags/post/responses/201/content/application~1json%3B%20charset%3Dutf-8/schema/properties/data/properties/created_at/definitions/date-time'
                              additionalProperties: false
                        created_by:
                          type: string
                        last_modified_at:
                          $ref: '#/paths/~1v3~1partner~1partnerize-tags/post/responses/201/content/application~1json%3B%20charset%3Dutf-8/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:
                      partner: 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/tags/file.js
                  - id: 111111l36
                    scope:
                      partner: 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/tags/file.js
    post:
      summary: Create Partnerize Tag
      operationId: createPartnerizeTag
      description: Generates a new Partnerize Tag for the requested partner. 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:
                    partner:
                      type: string
                      description: Partner ID for the new Partnerize Tag
      responses:
        '201':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    data:
                      id: 111111l35
                      scope:
                        partner: 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/tags/file.js
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: object
                description: Partnerize Tag data
                properties:
                  data:
                    type: object
                    $ref: '#/paths/~1v3~1partner~1partnerize-tags/get/responses/200/content/application~1json/schema/properties/data/items'
          description: OK
  /v3/partner/{partnerId}/participations:
    get:
      summary: List Partner Participations
      operationId: listPartnerParticipations
      description: 'Returns a list of Partner participations with basic campaign details.
        
      

        > ### Migrating From Previous Versions

        > #### Migrating From V1 endpoint

        > This endpoint supersedes the v1 endpoint

        > #### Migrating From V2 endpoint

        > The V2 endpoint returns campaigns of all statuses by default. This V3 endpoint
        only returns active campaigns by default, but this can be configured using
        the `campaign_status` URL query parameter to behave the same as the V2 endpoint
        by appending `?campaign_status[]=a&campaign_status[]=r` to the URL.

        '
      tags:
      - Participations
      parameters:
      - description: ID of the Partner
        example: 111111l3
        in: path
        name: partnerId
        required: true
        schema:
          type: string
      - description: 'This filter is based on the status of a partner''s relationship
          to campaigns. For example this can be used to find all campaigns that the
          partner is approved on to (`a`), or invited to (`t`). Default value `a`.

          * `r` = rejected

          * `a` = approved

          * `p` = pending (requested)

          * `t` = invited (pending terms and conditions)

          '
        example: a
        in: query
        name: status[]
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - r
            - a
            - p
            - t
      - description: 'This filter can be used to find campaigns that the partner is
          associated with, based on the campaign''s status. Default value `a`

          * `a` = active (campaigns that are currently live in the Partnerize platform)

          * `r` = retired (campaigns that are no longer live in the Partnerize platform)

          '
        example: a
        in: query
        name: campaign_status[]
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - a
            - r
      - description: 'This filter can be used to find campaigns that the partner is
          associated with, based on the partner''s status with the campaign''s brand
          network. By default this filter will not be applied.

          * `a` = approved (will filter participations to those where the partner
          is approved onto the campaign''s brand network)

          * `p` = pending (will filter participations to those where the partner is
          pending approval / rejection onto the campaign''s brand network)

          * `r` = rejected (will filter participations to those where the partner
          is rejected from the campaign''s brand network)

          '
        example: a
        in: query
        name: network_status[]
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - a
            - p
            - r
      - description: Specify what additional data properties should be returned in
          the response payload
        example: promotional_countries
        in: query
        name: fields[]
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - camref
            - vertical
            - promotional_countries
            - default_currency
            - brand_id
            - status
            - icon
            - week_start
            - hidden_campaign
            - reporting_timezone
            - network_status
      responses:
        '200':
          description: Request Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: object
                description: List Partner Participations
                properties:
                  data:
                    type: array
                    items:
                      $schema: http://json-schema.org/draft-07/schema#
                      type: object
                      title: Partner Participation object
                      properties:
                        campaign_id:
                          type: string
                        status:
                          type: string
                          description: This represents the status of the partner's
                            relationship to the campaign
                        approved:
                          type: string
                          format: date-time
                        agreed_latest_terms:
                          type: string
                        custom_terms:
                          type: string
                        campaign_info:
                          type: object
                          properties:
                            title:
                              type: string
                            secure_tracking:
                              type: string
                            cpc_tracking_link:
                              type: string
                              format: uri
                              nullable: true
                            destination_url:
                              type: string
                              format: uri
                            tracking_link:
                              type: string
                              format: uri
                              nullable: true
                            tracking_link_mobile:
                              type: string
                              nullable: true
                            allow_deep_linking:
                              type: string
                            campaign_languages:
                              type: object
                              properties:
                                de|fr|es|it|...:
                                  type: object
                                  properties:
                                    destination_url:
                                      type: string
                                      format: uri
                              nullable: true
                      additionalProperties: false
                      example:
                        'campaign_id:': 111111l13
                        status: a
                        approved: '2022-09-24T14:15:22+00:00'
                        agreed_latest_terms: y
                        custom_terms: y
                        'campaign_info:':
                          title: Cards & Loans
                          secure_tracking: y
                          cpc_tracking_link: null
                          destination_url: http://partnerize.com
                          tracking_link: https://prf.partnerize.tech/click/camref:111111lb
                          tracking_link_mobile: null
                          allow_deep_linking: y
                          campaign_languages:
                            de:
                              destination_url: https://partnerize.com/de
                            es:
                              destination_url: https://partnerize.com/es
  /v3/partner/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:
      - description: ID of the Partnerize Tag to fetch
        example: 111111l3
        in: path
        name: partnerizeTagId
        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~1partner~1partnerize-tags/get/responses/200/content/application~1json/schema/properties/data/items'
                example:
                  data:
                    id: 111111l35
                    scope:
                      partner: 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/tags/file.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:
                        partner: 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/tags/file.js
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: object
                description: Partnerize Tag data
                properties:
                  data:
                    type: object
                    $ref: '#/paths/~1v3~1partner~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/partner/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/partner/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:': tracking-link-generation
                        'description:': Tracking link generation from standard brand
                          URLs
                        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: tracking-link-generation
      responses:
        '201':
          content:
            application/json; charset=utf-8:
              examples:
                response:
                  value:
                    data:
                      name: tracking-link-generation
                      config: null
              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/partner/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/partner/my-brands:
    get:
      summary: List My Brands
      operationId: listMyBrands
      description: Information about the brands the authenticated partner is associated
        with. This will include brands from networks they've been blocked from.
      tags:
      - My Brands
      parameters:
      - name: brand_ids[]
        in: query
        description: If you only want to retrieve information about a specific set
          of brands, apply this filter
        required: false
        example: 111111l1
        schema:
          type: array
          items:
            type: string
      - name: partner
        in: query
        description: If you only want to retrieve brand information for brands that
          are associated with a specific partner, apply this filter
        required: false
        example: 111111l1
        schema:
          type: string
      responses:
        '200':
          description: The list was retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $schema: http://json-schema.org/draft-07/schema#
                      type: object
                      properties:
                        brand_id:
                          type: string
                          examples:
                          - 111111l1
                        name:
                          type: string
                          examples:
                          - brand name
                        display_name:
                          type: string
                          examples:
                          - display name
                          nullable: true
                        address1:
                          type: string
                          examples:
                          - address line 1
                          nullable: true
                        address2:
                          type: string
                          examples:
                          - 'address line '
                          nullable: true
                        address3:
                          type: string
                          examples:
                          - address line 3
                          nullable: true
                        address4:
                          type: string
                          examples:
                          - address line 4
                          nullable: true
                        postcode:
                          type: string
                          examples:
                          - postcode
                          nullable: true
                        country:
                          type: string
                          examples:
                          - country
                          nullable: true
                        contact_email:
                          type: string
                          examples:
                          - email@user.com
                          nullable: true
                        icon:
                          type: string
                          examples:
                          - http://image.com/path/to/imag
                          nullable: true
                        description:
                          type: string
                          examples:
                          - brand description
                          nullable: true
                        blocked:
                          description: The will return true if the brand is on a network
                            that the partner was guested to but the partner has since
                            been blocked from the brand's network
                          type: boolean
                          examples:
                          - false
                  execution_time:
                    type: string
                    example: 0.515 seconds
  /v3/partner/campaign-terms-and-conditions:
    get:
      summary: List campaign terms and conditions
      operationId: listCampaignTerms
      description: Lists all campaign terms and conditions of the campaigns managed
        by the user. Terms and conditions will be bound to your user's locale. If
        no terms for your locale exist, terms for `en` or `en_us` will be returned
        in it's place.
      tags:
      - Campaign Terms and Conditions
      parameters:
      - name: campaign_id
        in: query
        description: Filter by campaign.
        schema:
          type: string
          example: 111111l5
      - name: created_at
        in: query
        description: Filter by created datetime.
        schema:
          type: string
          example: 2020-01-01T00:00:00Z..2020-12-31T23:59:59Z
      - name: locale
        in: query
        description: Filter by locale.
        schema:
          $ref: '#/components/schemas/Locale'
      - name: content
        in: query
        description: Filter by content.
        schema:
          type: string
          example: cookies
      responses:
        '200':
          description: Request Success
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Campaign_Terms_And_Condition'
  /v3/partner/campaign-terms-and-conditions/{id}:
    get:
      summary: Retrieve campaign terms and conditions
      operationId: retrieveCampaignTerms
      description: Retrieves a single campaign terms and conditions
      tags:
      - Campaign Terms and Conditions
      parameters:
      - name: id
        in: path
        description: The ID of the campaign terms and conditions
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Request Success
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/Campaign_Terms_And_Condition'
  /v3/partner/campaign-terms-and-conditions-acknowledgments:
    get:
      summary: List campaign terms and conditions acknowledgments
      operationId: listCampaignTermAcknowledgments
      description: Lists all acknowledgements for campaign terms and conditions of
        the partners managed by the user.
      tags:
      - Campaign Terms and Conditions Acknowledgments
      parameters:
      - name: partner_id
        in: query
        description: Filter by partner.
        schema:
          type: string
          example: 111111l34
      - name: campaign_terms_and_conditions_id
        in: query
        description: Filter by campaign terms and conditions.
        schema:
          type: string
          example: 111111l50
      - name: created_at
        in: query
        description: Filter by created datetime.
        schema:
          type: string
          example: 2020-01-01T00:00:00Z..2020-12-31T23:59:59Z
      - name: created_by
        in: query
        description: Filter by created by user.
        schema:
          type: string
          example: 111111l2
      responses:
        '200':
          description: Request Success
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Campaign_Terms_And_Condition_Acknowledgement'
    post:
      summary: Create campaign terms and conditions acknowledgment
      operationId: createCampaignTermAcknowledgment
      description: Create an acknowledgement for campaign terms and conditions
      tags:
      - Campaign Terms and Conditions Acknowledgments
      requestBody:
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                partner_id:
                  type: string
                campaign_terms_and_conditions_id:
                  type: string
              required:
              - partner_id
              - campaign_terms_and_conditions_id
              additionalProperties: false
            example:
              partner_id: 111111l34
              campaign_terms_and_conditions_id: 111111l50
      responses:
        '201':
          description: Request Success
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/Campaign_Terms_And_Condition_Acknowledgement'
  /v3/partner/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 email has been verified
                      email:
                        type: string
                        format: email
                        description: Email address of a Current User
          description: OK
  /v3/partner/campaign-terms-and-conditions-acknowledgments/{id}:
    get:
      summary: Retrieve campaign terms and conditions acknowledgment
      operationId: retrieveCampaignTermAcknowledgment
      description: Retrieves a single acknowledgment of campaign terms and condition
      tags:
      - Campaign Terms and Conditions Acknowledgments
      parameters:
      - name: id
        in: path
        description: The ID of the acknowledgment
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Request Success
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    example:
                      id: 111111l551
                      partner_id: 111111l34
                      campaign_terms_and_conditions_id: 111111l50
                      created_at: 2020-01-01T00:00:00+0000
                      created_by: 111111l2
components:
  schemas:
    Partner:
      properties:
        abn:
          type: string
        account_name:
          type: string
        campaign_select:
          type: string
        company_name:
          type: string
        company_division:
          type: string
        company_logo:
          type: string
          nullable: true
        contact_email:
          type: string
          format: email
        contact_locale:
          $ref: '#/components/schemas/Locale'
        contact_name:
          type: string
        default_currency:
          $ref: '#/components/schemas/Currency'
        description:
          type: string
          description: Description of the publisher
        foreign_identifier:
          type: string
        gst_registered:
          type: string
        im_provider:
          type: string
        im_username:
          type: string
        is_affiliate_user:
          $ref: '#/components/schemas/YesOrNo'
        is_foreign_network:
          description: Reporting only flag. All conversions will be automatically
            approved but will not be invoiceable.
          $ref: '#/components/schemas/YesOrNo'
        is_lead_user:
          $ref: '#/components/schemas/YesOrNo'
        legal_entity:
          $ref: '#/components/schemas/Country'
        network_id:
          type: string
          description: ID of the network this publisher belongs to
        network_notes:
          type: string
        network_status:
          $ref: '#/components/schemas/Status'
        operating_country:
          $ref: '#/components/schemas/Country'
        phone:
          type: string
          description: Primary contact telephone number
        phone_area:
          type: string
          description: Phone prefix to declare country or region
        promotional_method_name:
          type: string
        promotional_method:
          type: integer
        publisher_id:
          type: string
          description: ID of the publisher
        reporting_identifier:
          type: string
        reporting_timezone:
          type: string
        signup_ip:
          type: string
          format: ipv4
        uk_vat_registered:
          $ref: '#/components/schemas/YesOrNo'
        us_tax_state:
          type: string
        vat_number:
          type: integer
        vertical:
          type: integer
        vertical_name:
          type: string
        week_start:
          type: string
    Partner_Campaign_Wrapper:
      properties:
        campaign:
          allOf:
          - $ref: '#/components/schemas/Campaign'
          - properties:
              campaign_custom_terms_and_conditions_id:
                type: string
              campaign_custom_terms_and_conditions_title:
                type: string
              publisher_status:
                $ref: '#/components/schemas/Status'
            type: object
      type: object
    Partner_Campaign_Creative:
      properties:
        campaign_creative:
          properties:
            campaign_id:
              description: Id of the campaign
              type: string
            creatives:
              properties:
                Banner:
                  description: number of Banner creatives
                  type: number
                Email:
                  description: number of Emails
                  type: number
                Feed:
                  description: number of Feeds
                  type: number
                HTML:
                  description: number of HTML creatives
                  type: number
                HTML Form:
                  description: number of HTML Forms
                  type: number
                Text Link:
                  description: number of Text links
                  type: number
              type: object
          type: object
    Feed:
      properties:
        feed:
          properties:
            campaign_feeds_id:
              description: ID of the Feed
              type: string
            campaign_id:
              description: ID of the Campaign
              type: string
            creative_id:
              description: ID of the Creative
              type: string
            filename:
              type: string
            filesize:
              type: number
            filesize_compressed:
              type: number
            last_processed:
              description: UNIX timestamp
              type: number
            location:
              type: string
            name:
              type: string
            title:
              description: name of the Campaign
              type: string
            updated:
              description: UNIX timestamp
              type: number
          type: object
      type: object
    Selfbill:
      properties:
        selfbill:
          properties:
            creation_date:
              type: string
            download:
              description: URL for PDF download
              nullable: true
              type: string
            item_download:
              description: URL for CSV item download
              nullable: true
              type: string
            items_in_bill:
              type: number
            legal_entity:
              $ref: '#/components/schemas/Country'
            majority_received_currency:
              $ref: '#/components/schemas/Currency'
            net_value:
              type: number
            paid_currency:
              $ref: '#/components/schemas/Currency'
            payment_batch_id:
              nullable: true
              type: string
            payment_date:
              nullable: true
              type: string
            payment_detail_set_id:
              type: number
            publisher_id:
              description: ID of the partner
              type: string
            publisher_payment_detail_set_id:
              nullable: true
              type: string
            publisher_self_bill_id:
              type: string
            publisher_self_bill_reference:
              nullable: true
              type: string
            self_bill_reference:
              type: string
            selfbill_currency:
              $ref: '#/components/schemas/Currency'
            status:
              enum:
              - created
              type: string
            timestamp:
              type: string
            total_value:
              type: number
            tracked_currency:
              $ref: '#/components/schemas/Currency'
            tracked_net_value:
              type: number
            vat_rate:
              type: number
            vat_value:
              type: number
            withheld_tax:
              type: number
          type: object
      type: object
    Payment_Details:
      properties:
        1011l22:
          description: Dynamic property name equal to the Payment details set Id.
            Example - 1011l22
          properties:
            publisher_payment_detail_set_id:
              type: string
            country:
              $ref: '#/components/schemas/Country'
            paid_currency:
              $ref: '#/components/schemas/Currency'
            tracked_currency:
              items:
                $ref: '#/components/schemas/Currency'
              type: array
            payment_type_code:
              type: string
            payment_type_name:
              type: string
            automatic_self_bill_creation_date:
              type: string
            automatic_self_bill_creation_threshold:
              type: string
            suspended:
              $ref: '#/components/schemas/YesOrNo'
            suspended_at:
              type: string
            suspended_by:
              type: string
            suspended_notes:
              type: string
            payment_detail_values:
              properties:
                bank_address:
                  type: string
                account_number:
                  type: number
                account_name:
                  type: string
                bank_name:
                  type: string
                routing_number:
                  type: number
              type: object
          type: object
    Link:
      properties:
        id:
          type: string
        campaign_id:
          type: string
        description:
          type: string
        destination_url:
          type: string
        tracking_short_url:
          type: string
        tracking_url:
          type: string
        params:
          items:
            $ref: '#/components/schemas/Key_Value_Pair'
        active:
          type: boolean
      type: object
    Key_Value_Pair:
      properties:
        key:
          type: string
        value:
          type: string
      type: object
    Partner_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
    Partner_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
    Partner_Overview_Primary:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          campaigns:
            items:
              properties:
                campaign:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      campaign_id:
                        type: string
                      title:
                        type: string
            type: array
    Partner_Overview_Country:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          countrys:
            items:
              properties:
                country:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      country_iso:
                        $ref: '#/components/schemas/Country'
            type: array
    Partner_Overview_Self:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          publishers:
            items:
              properties:
                publisher:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      publisher_id:
                        type: string
                      title:
                        type: string
            type: array
    Partner_Overview_Product:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          products:
            items:
              properties:
                product:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      product:
                        type: string
            type: array
    Partner_Overview_Pubref:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          pubrefs:
            items:
              properties:
                pubref:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      reserved_tag_name:
                        type: boolean
                      pubref:
                        type: string
            type: array
    Partner_Overview_Adref:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          adrefs:
            items:
              properties:
                adref:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      adref:
                        type: string
            type: array
    Partner_Overview_Creative:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          creatives:
            items:
              properties:
                creative:
                  allOf:
                  - $ref: '#/components/schemas/Partner_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
    Partner_Overview_Agent:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          agents:
            items:
              properties:
                agent:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      agent_name:
                        type: string
                      agent_items:
                        items: {}
                        type: array
            type: array
    Partner_Overview_Custref:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          custrefs:
            items:
              properties:
                custref:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      custref:
                        type: string
            type: array
    Partner_Overview_Type:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          types:
            items:
              properties:
                type:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      type:
                        type: number
            type: array
    Partner_Overview_Device:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          devices:
            items:
              properties:
                device:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      device_id:
                        type: number
                      device_title:
                        type: string
            type: array
    Partner_Overview_Source:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          sources:
            items:
              properties:
                source:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      source_id:
                        type: number
                      source_title:
                        type: string
            type: array
    Partner_Overview_Partnership:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          parnterships:
            items:
              properties:
                parntership:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      parntership_id:
                        type: number
                      partnership_title:
                        type: string
            type: array
    Partner_Overview_Metric:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          metrics:
            items:
              properties:
                metric:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      metric_id:
                        type: number
                      metric_title:
                        type: string
            type: array
    Partner_Overview_Context:
      allOf:
      - $ref: '#/components/schemas/Partner_Overview_Base'
      - type: object
        properties:
          contexts:
            items:
              properties:
                context:
                  allOf:
                  - $ref: '#/components/schemas/Partner_Overview_Currency_Stats'
                  - type: object
                    properties:
                      context_id:
                        type: number
                      context_title:
                        type: string
            type: array
    Partner_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
    Partner_Overview_Period:
      properties:
        totals:
          $ref: '#/components/schemas/Partner_Overview_Period_Stats'
      start_block:
        type: number
      end_block:
        type: number
      start_time:
        type: string
      end_time:
        type: string
      stats:
        $ref: '#/components/schemas/Partner_Overview_Period_Stats'
    Partner_Overview_Multidate_Current:
      properties:
        period:
          properties:
            current:
              $ref: '#/components/schemas/Partner_Overview_Period'
          type: object
        utc_offset:
          type: number
    Partner_Overview_Multidate_Ranges:
      properties:
        period:
          items:
            properties:
              range{index}:
                description: an indexed range. E.g. range0, range1, etc.
                $ref: '#/components/schemas/Partner_Overview_Period'
            type: object
          type: array
        utc_offset:
          type: number
    Partner_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_publisher_commission:
          description: 'total 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
    Partner_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:
            allOf:
            - $ref: '#/components/schemas/Click'
            - type: object
              properties:
                meta_data:
                  type: array
                  description: Key value pairs of meta data
                  items:
                    properties:
                      key:
                        description: A key value pair.
                        type: string
      type: object
    Conversion_Data:
      type: object
      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
        creative_type:
          type: number
        creative_id:
          type: number
        specific_creative_id:
          type: number
        currency:
          $ref: '#/components/schemas/Currency'
        publisher_reference:
          type: string
        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
          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
        conversion_lag:
          type: number
        clickref:
          type: string
    Click:
      properties:
        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
        publisher_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
    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
        last_update:
          type: string
        publisher_self_bill_id:
          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
        payable:
          type: boolean
      type: object
    Conversion_Status:
      enum:
      - pending
      - approved
      - rejected
      type: string
    Campaign_Terms_And_Condition:
      type: object
      properties:
        id:
          type: string
          example: 111111l10
        created_at:
          type: string
          example: 2020-01-01T00:00:00+0000
        locale:
          type: string
          example: en_us
        content:
          type: string
          example: 
      Lorem Ipsum
      
        campaign_id:
          type: string
          example: 111111l5
    Campaign_Terms_And_Condition_Acknowledgement:
      type: object
      properties:
        id:
          type: string
          example: 111111l551
        partner_id:
          type: string
          example: 111111l34
        campaign_terms_and_conditions_id:
          type: string
          example: 111111l50
        created_at:
          type: string
          example: 2020-01-01T00:00:00+0000
        created_by:
          type: string
          example: 111111l2
    Campaign:
      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
        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
        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_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
        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
        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'
        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
    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 publishers 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
    Partner_Website:
      properties:
        publisher_id:
          description: ID of the partner the website belongs to
          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
    Partner_Website_Wrapper:
      properties:
        website:
          allOf:
          - type: object
            properties:
              website_id:
                description: ID of the partner website
                type: string
          - $ref: '#/components/schemas/Partner_Website'
      type: object
    Partner_Database:
      properties:
        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
    Partner_Database_Wrapper:
      properties:
        database:
          allOf:
          - type: object
            properties:
              database_id:
                description: ID of the partner database
                type: string
          - $ref: '#/components/schemas/Partner_Database'
      type: object
    Partner_Payment_Summary:
      properties:
        execution_time:
          type: string
        summary:
          properties:
            available:
              description: Amount of money available to the partner to withdraw
              title: The propery name* is the currency code and the value is amount
                of money, e.g. 'GBP':'12.45'
              additionalProperties:
                type: number
                description: Amount of money
              type: object
            confirmed:
              description: Amount that will be available once issued brand's invoices
                are paid
              title: The propery name* is the currency code and the value is amount
                of money, e.g. 'GBP':'12.45'
              additionalProperties:
                type: number
                description: Amount of money
              type: object
            pending:
              description: Total value of pending conversions
              title: The propery name* is the currency code and the value is amount
                of money, e.g. 'GBP':'12.45'
              additionalProperties:
                type: number
                description: Amount of money
              type: object
            approved:
              description: Total value of approved conversions
              title: The propery name* is the currency code and the value is amount
                of money, e.g. 'GBP':'12.45'
              additionalProperties:
                type: number
                description: Amount of money
              type: object
            paid:
              description: Amount already paid
              title: The propery name* is the currency code and the value is amount
                of money, e.g. 'GBP':'12.45'
              additionalProperties:
                type: number
                description: Amount of money
              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
    YesOrNo:
      enum:
      - y
      - n
      type: string
    Currency:
      enum:
      - GBP
      - USD
      - EUR
      - JPY
      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
    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
    Timezones:
      enum:
      - Australia/Sydney
      - UTC
      - Europe/London
      - CET
      - GMT
      type: string
    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
    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
    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