Optimise Media

https://docs.optimisemedia.com
Admin
Optimise Media is an affiliate marketing network platform that connects advertisers and publishers...
Tokens:55,212
Snippets:648
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Adjust Install Callback Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

Use this URL-encoded string for the `install_callback` parameter in Adjust to track install events. Ensure all placeholders are replaced with your actual tracking platform values and Adjust macros.

```url
&install_callback=https%3A%2F%2Ftrack.example.com%2Fe%2Fmp%3FApplicationKey%3D{APPLICATION_KEY}%26MID%3D{MID}%26PID%3D{PID}%26REF%3DAdjust%26APPID%3D%7Bandroid_id%7D%26STATUS%3D1%26sskey%3D{sskey}%26EX1%3D%7Bapp_id%7D%26CURRENCY%3D%7Bcurrency%7D%26ANDROIDID%3D%7Bandroid_id%7D%26DEVICEOSVERSION%3D%7Bos_version%7D%26DEVICENAME%3D%7Bdevice_name%7D%26deviceip%3D%7Bip_address%7D%26EX3%3D%7Bcity%7D%26platform%3Dapp
```

--------------------------------

### Conversion Postback Request Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/s2s

This is an example of a GET or POST request for a Conversion Postback. It should be activated on the post-sale confirmation page. All endpoints support POST requests with parameters in JSON format. The body parameters are identical to query string parameters, with body values taking priority if duplicated.

```url
https://track.omguk.com/e/s/s2s/?AppID=%SaleReference%&MID=%MID%&PID=%PID%&Action=Sale&Status=&TransactionValue=%TotalOrderValue%&sskey=%sskey%&Channel=Optimise&CustID=%CustomerID%&Vcode=%VoucherCode%
```

--------------------------------

### Adjust-Hosted OneLink Callback Parameters

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

These are example parameters for an Adjust-hosted OneLink, including install and event callbacks. Ensure all callback values are URL-encoded.

```url
?adj_t=1abcdef  
&adj_campaign=My+App+Acquisition  
&adj_adgroup={AID}  
&adj_click_id={sskey}  
&adj_install_callback=optimise_install%26MID%3D{MID}%26PID%3D{PID}%26AID%3D%7BAID%7D%26sskey%3D%7Bsskey%7D  
&event_callback_r5xw5n=optimise_registration%26MID%3D{MID}%26PID%3D{PID}%26iCat%3DContactDetailsSubmission%26AID%3D%7BAID%7D%26Ex1%3DContactDetailsSubmission%26sskey%3D%7Bsskey%7D  
&event_callback_ospxm8=optimise_registration%26MID%3D{MID}%26PID%3D{PID}%26iCat%3DWelcomeScreen_Completion%26AID%3D%7BAID%7D%26Ex1%3DWelcomeScreen_Completion%26sskey%3D%7Bsskey%7D  
&event_callback_8osc8d=optimise_registration%26MID%3D{MID}%26PID%3D{PID}%26iCat%3DReview2_Completion%26AID%3D%7BAID%7D%26Ex1%3DReview2_Completion%26sskey%3D%7Bsskey%7D  
```

--------------------------------

### Pass sskey Parameter Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/universal-tracking

Example of how to pass the 'sskey' parameter and value pair if redirecting or manipulating the landing page URL.

```url
https://www.advertiser-website.com/?sskey=%sskey%
```

--------------------------------

### Event Postback Request Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/s2s

This is an example of a GET or POST request for an Event Postback. All endpoints support POST requests with parameters in JSON format. The body parameters are identical to query string parameters, with body values taking priority if duplicated.

```url
https://track.omguk.com/e/q/s2s/?AppID=%Reference%&MID=%MID%&PID=%PID%&Action=%Event%&sskey=&DeviceIP=%DeviceIP%&ref=https%3A%2f%2fwww.yourwebsitecom%2fcar-insurance%2f
```

--------------------------------

### Example Postback URL

Source: https://docs.optimisemedia.com/docs/publishers/publishertracking

This is an example of a postback URL that can be added to a campaign. It includes various supported macros for tracking different transaction details.

```url
https://www.callbackurl.com/?SaleID=%SALEREF%VoucherUsed=%VCODE%&SaleValue=%STATUS%&SubID1=%UID%&SubID2=%UID2%&SubID3=%UID3%&SubID4=%UID4%&SubID5=%UID5%&Ex1=%EX1%&Ex2=%EX2%&Ex3=%EX3%&Ex4=%EX4%&Ex5=%EX5%
```

--------------------------------

### Branch Postback for Install

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

Configure Branch to call your Optimise endpoint on install. Replace the tracking domain and ApplicationKey. Branch template variables are substituted at runtime.

```url
https://track.omguk.com/mobileapptracking/TrackingService.svc/track?ApplicationKey={APPLICATION_KEY}&STATUS=${ (event_data.revenue)! }&CURRENCY=${ (event_data.currency)! }&sskey=${ (last_attributed_touch_data.~click_id)! }&EX1=${ (name)! }&DEVICEOSVERSION=${ (user_data.os_version)! }&DEVICEIP=${ (user_data.ip)! }&GoogleID=${ (user_data.aaid)! }&IFA=${ (user_data.idfa)! }&APPVERSION=${ (user_data.app_version)! }&MID=${ (last_attributed_touch_data.mid)! }&PID=${ (last_attributed_touch_data.pid)! }&EX3=${ (user_data.os)! }&APPID=${ (event_data.transaction_id)! }&EX4=${ (user_data.geo_city_en)! }&ref=Branch&ua=${ (user_data.user_agent)! }&AID=${ (last_attributed_touch_data.aid)! }&UID=${ (last_attributed_touch_data.uid)! }
```

--------------------------------

### Conversion Postback Example - Finance

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/s2s

An example of a Conversion Postback URL with additional parameters specific to finance transactions. These parameters can be appended to track specific details.

```url
https://track.omguk.com/e/s/s2s/?AppID=%SaleReference%&MID=%MID%&PID=%PID%&Action=Sale&Status=&TransactionValue=%TransactionOrderValue%&iPurpose=%PurposeOfLoan%&iDuration=%DurationOfLoan%&Vcode=%VoucherCode%&Channel=%Channel%&iMeta=%Meta%
```

--------------------------------

### DoubleClick Click Tracker Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/integrations

An example of a DoubleClick click tracker URL. Ensure to use the correct parameters for your campaign.

```url
http://ad.doubleclick.net/clk;263036570;88365486;t
```

--------------------------------

### Rejected Install Callback URL

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

Use this URL to track rejected app installs. Ensure to replace placeholders like {APPLICATION_KEY}, {MID}, {PID}, and {sskey} with your specific values.

```url
&rejected_install_callback=https%3A%2F%2Ftrack.example.com%2Fe%2Fmp%3FApplicationKey%3D{APPLICATION_KEY}%26MID%3D{MID}%26PID%3D{PID}%26REF%3DAdjust%26APPID%3D%7Bpublisher_parameters%7D%26STATUS%3D0%26sskey%3D{sskey}%26EX1%3D%7Bapp_id%7D%26ANDROIDID%3D%7Bandroid_id%7D%26DEVICEOSVERSION%3D%7Bos_version%7D%26DEVICENAME%3D%7Bdevice_name%7D%26GoogleID%3D%7Bgps_adid%7D%26deviceip%3D%7Bip_address%7D%26EX3%3D%7Bcity%7D%26RejectReason%3D%7Brejection_reason%7D%26platform%3Dapp
```

--------------------------------

### Optimise Tracking Macro URL Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/publisher-content/ads-banners

Prefix all click-out URLs with Optimise Tracking Macros to ensure emails track correctly. This example shows the base URL structure.

```URL
https://track.omguk.com/?AID=%AID%&PID=%PID%&CRID=%CRID%&r=
```

--------------------------------

### iOS Universal Link Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

This is an example of a Universal Link for iOS. It should be URL-encoded before being appended to the JSR endpoint.

```url
https://ab12.adj.st/?adjust_t=abc123  
```

--------------------------------

### Get Placement Response Sample

Source: https://docs.optimisemedia.com/api

This is a sample JSON response for a successful retrieval of placement details.

```json
{
  "id": 0,
  "campaignId": 0,
  "identifier": "string",
  "description": "string",
  "thirdPartyUrl": "string",
  "type": 0,
  "dateCreated": "string",
  "userCreated": 0,
  "importType": 0,
  "isDeleted": "string",
  "userName": "string",
  "userSecondName": "string",
  "clickURLTemplate": "string",
  "contactID": "string",
  "maskURL": "string",
  "affiliateName": "string",
  "placementType": "string",
  "productId": "string",
  "affiliateContactId": "string",
  "campaignName": "string",
  "advertiserName": "string",
  "agencyId": "string"
}
```

--------------------------------

### Conversion Postback Example - Insurance

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/s2s

An example of a Conversion Postback URL with additional parameters specific to insurance transactions. These parameters can be appended to track specific details.

```url
https://track.omguk.com/e/s/s2s/?AppID=%SaleReference%&MID=%MID%&PID=%PID%&Action=Sale&Status=&TransactionValue=%TransactionOrderValue%&iPolicytype=%PolicyType%&iPolicyValue=%PolicyValue%&iStartDate=%StartDate%&iEndDate=%EndDate%&iPolicySpecific=%PolicySpecific%&iPaymentType=%PaymentType%&Vcode=%VoucherCode%&Channel=%Channel%&iMeta=%Meta%
```

--------------------------------

### Branch Postback for In-App Event

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

Use the same structure as the install postback for in-app events. The EX5 flag indicates if this is the user’s first event.

```url
https://track.omguk.com/mobileapptracking/TrackingService.svc/track?ApplicationKey={APPLICATION_KEY}&STATUS=${ (event_data.revenue)! }&CURRENCY=${ (event_data.currency)! }&sskey=${ (last_attributed_touch_data.~click_id)! }&EX1=${ (name)! }&DEVICEOSVERSION=${ (user_data.os_version)! }&DEVICEIP=${ (user_data.ip)! }&GoogleID=${ (user_data.aaid)! }&IFA=${ (user_data.idfa)! }&APPVERSION=${ (user_data.app_version)! }&MID=${ (last_attributed_touch_data.mid)! }&PID=${ (last_attributed_touch_data.pid)! }&EX3=${ (user_data.os)! }&APPID=${ (event_data.transaction_id)! }&EX5=<#if (first_event_for_user)?? && first_event_for_user>1<#else>0</#if>&EX4=${ (user_data.geo_city_en)! }&ref=Branch&ua=${ (user_data.user_agent)! }&AID=${ (last_attributed_touch_data.aid)! }&UID=${ (last_attributed_touch_data.uid)! }
```

--------------------------------

### Get File Response Sample

Source: https://docs.optimisemedia.com/api

Response for retrieving a file, providing a presigned URL for accessing the file content.

```json
{
  "presignedUrl": "string"

}
```

--------------------------------

### India Regional Domain Tracking Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

An example of a tracking URL using the Adjust India regional domain. Replace placeholders as needed.

```url
https://app.adjust.net.in/XXXX?adgroup=XXX&idfa=XXXX&gps_adid=XXX&android_id=XXXX  
```

--------------------------------

### Optimise Consent Signal Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/overview

This example demonstrates how the Optimise Consent Signal appends a query string parameter to the Advertiser Landing page URL when a user originates from a publisher site with a consent exemption.

```url
https://www.advertiser.com/landing-page?utm_source=Optimise&oConsent=1
```

--------------------------------

### Capture sskey from Website URL

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/s2s

Example of how an 'sskey' is appended to a website URL. This key must be retrieved from the query string and stored.

```url
https://www.advertiser.com/?sskey=86a0a0b15e0143c8a14bd9c25628aecb
```

--------------------------------

### Reporting API Response Sample

Source: https://docs.optimisemedia.com/api

Example of a successful response when requesting reporting data.

```json
[
  {
    "property1": "string",
    "property2": "string"
}

]
```

--------------------------------

### Finance Conversion Tag Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/universal-tracking

Implementation of the Universal Conversion Tag for the finance sector, including a JavaScript tag and a fallback noscript pixel. Ensure %MID% and %PID% are replaced.

```html
<script type="text/javascript" src="https://track.omguk.com/%MID%/e/ss/?AppID=%SaleReference%&MID=%MID%&PID=%PID%&Action=Sale&Status=&TransactionValue=%TransactionOrderValue%&iPurpose=%PurposeOfLoan%&iDuration=%DurationOfLoan%&Vcode=%VoucherCode%&Channel=%Channel%&iMeta=%Meta%"></script>
<noscript><img src="https://track.omguk.com/e/si/?AppID=%SaleReference%&MID=%MID%&PID=%PID%&Action=Sale&Status=&TransactionValue=%TransactionOrderValue%&iPurpose=%PurposeOfLoan%&iDuration=%DurationOfLoan%&Vcode=%VoucherCode%&Channel=%Channel%&iMeta=%Meta%" border="0" height="1" width="1"></noscript>
```

--------------------------------

### DoubleClick Floodlight Example on Advertiser Confirmation Page

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/integrations

An example of a DoubleClick Floodlight tag implemented as an iframe on an advertiser's confirmation page. This setup allows for passing various JavaScript variables as parameters.

```html
<iframe src="https://5737208.fls.doubleclick.net/activityi;src=5737208;type=thank0;cat=reser0;qty=1;cost=%JS_TotalCostWithTax%;u1=%JS_ArrivalDtYYYYMMDD%;u2=%JS_DepartDtYYYYMMDD%;u3=%JS_NightsQty%;u4=%JS_CCountry%;u5=%JS_GuestQty%;u6=%JS_ChildQty%;u7=%JS_RmQty%;u8=%JS_RoomName%;u9=%JS_TotalCost%;u10=%JS_CurrCode%;u11=%JS_RateName%;u12=%JS_HName%;u13=%JS_LangCode%;dc_lat=;dc_rdid=;tag_for_child_directed_treatment=;ord=%JS_ConfirmNo%?" width="1" height="1" frameborder="0" style="display:none"></iframe>
```

--------------------------------

### Adjust OneLink Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

A basic example of an Adjust OneLink URL. Replace 'XXXXXXX' with your actual OneLink ID and customize adgroup and creative parameters as needed.

```url
https://app.adjust.com/XXXXXXX?adgroup=ExampleGroup&creative=ExampleCreative
```

--------------------------------

### Optimise Test Publisher Click URL Example

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/tracking-testing

Use this URL format to generate a test click for your campaign. Replace %PID% with your campaign's PID and %AID% with the designated AID.

```url
https://clk.omgt1.com/?PID=%PID%&AID=%AID%
```

--------------------------------

### Adjust Callback Parameters

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

Sample parameters for Adjust callbacks when using a non-Adjust host like Branch. Ensure callback values are properly encoded.

```url
?adj_t=1abcdef
&adj_campaign=My+App+Acquisition
&adj_adgroup={AID}
&adj_click_id={sskey}
&adj_install_callback=optimise_install%26MID%3D{MID}%26PID%3D{PID}%26AID%3D%7BAID%7D%26sskey%3D%7Bsskey%7D
&event_callback_r5xw5n=optimise_registration%26MID%3D{MID}%26PID%3D{PID}%26iCat%3DContactDetailsSubmission%26AID%3D%7BAID%7D%26Ex1%3DContactDetailsSubmission%26sskey%3D%7Bsskey%7D
&event_callback_ospxm8=optimise_registration%26MID%3D{MID}%26PID%3D{PID}%26iCat%3DWelcomeScreen_Completion%26AID%3D%7BAID%7D%26Ex1%3DWelcomeScreen_Completion%26sskey%3D%7Bsskey%7D
&event_callback_8osc8d=optimise_registration%26MID%3D{MID}%26PID%3D{PID}%26iCat%3DReview2_Completion%26AID%3D%7BAID%7D%26Ex1%3DReview2_Completion%26sskey%3D%7Bsskey%7D
```

--------------------------------

### Create Contact Website Response Sample

Source: https://docs.optimisemedia.com/api

This is a sample JSON response indicating the successful creation of a contact website, returning the new contactWebsiteId.

```json
{
  "contactWebsiteId": 0
}
```

--------------------------------

### Branch Click URL with Optimise Parameters

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/mobile-app-tracking

Use a Branch link that includes Optimise parameters. Replace placeholders with your actual values. Ensure required values are URL-encoded.

```url
https://brand.app.link/XXXXX?%243p=a_optimise_media&%24aaid=&%24idfa=&mid={MID}&pid={PID}&aid={AID}&uid={UID}&uid2={UID2}&~secondary_publisher={SECONDARY_PUBLISHER}
```

--------------------------------

### Get Placement

Source: https://docs.optimisemedia.com/api

Retrieves a specific placement by its ID.

```APIDOC
## GET /placements/{placementId}

### Description
Retrieves a specific placement by its ID.

### Method
GET

### Endpoint
https://public.api.optimisemedia.com/v1/placements/{placementId}

### Parameters
#### Path Parameters
- **placementId** (integer) - Required - Id of the placement

#### Query Parameters
- **advertiserId** (integer) - Required - contactId of the advertiser
- **agencyId** (integer) - Required - Id of the agency
```

--------------------------------

### Get Invoices

Source: https://docs.optimisemedia.com/api

Retrieves a list of invoices with various filtering and sorting options.

```APIDOC
## GET /invoices/

### Description
Retrieves a list of invoices with various filtering and sorting options.

### Method
GET

### Endpoint
https://public.api.optimisemedia.com/v1/invoices/

### Parameters
#### Query Parameters
- **agencyId** (integer) - Required - Agency Id
- **contactId** (integer) - Required - Contact Id
- **startDate** (string) - Required - Start date
- **endDate** (string) - Optional - End date
- **status** (string) - Optional - Enum: "Draft" "Settled" "Contra" "Sent" "Allocated" Status
- **accountManager** (integer) - Optional - Account manager id
- **showPayments** (boolean) - Optional - Show the payments
- **invoiceId** (integer) - Optional - Invoice Id
- **myInvoiceId** (integer) - Optional - Exclude invoice Id
- **culture** (string) - Optional - Culture code
- **invoiceTypeId** (integer) - Optional - The type on invoice
- **includeDeleted** (boolean) - Optional - Show the deleted invoices
- **campaignName** (string) - Optional - Name of the campaign
- **showOnlyInvoicesWithNoOutstanding** (boolean) - Optional - Show invoices that are not outstanding
- **commissionTypeId** (integer) - Optional - Commission Type
- **currencyId** (integer) - Optional - currencyId
- **offset** (integer) - Optional - offset
- **limit** (integer) - Optional - limit
- **showOnlyUnpaidFODInvoice** (boolean) - Optional - showOnlyUnpaidFODInvoice
- **sortColumnName** (string) - Optional - sortColumnName
- **sortDirection** (string) - Optional - sortDirection
- **campaignIds** (string) - Optional - campaignIds
- **poNumber** (string) - Optional - poNumber

### Response
#### Success Response (200)
Successful response
- **invoiceId** (string) - Description
- **contactId** (string) - Description
- **accountManager** (string) - Description
- **advertiser** (string) - Description
- **date** (string) - Description
- **net** (number) - Description
- **vat** (number) - Description
- **gross** (number) - Description
- **dateCreated** (string) - Description
- **dateSent** (string) - Description
- **status** (string) - Description
- **invoiceType** (string) - Description
- **creditNoteAllocation** (number) - Description
- **commissionType** (string) - Description
- **deleted** (boolean) - Description
- **receipts** (number) - Description
- **oustanding** (number) - Description
- **currencySymbol** (string) - Description
- **poNumber** (string) - Description
- **poValue** (number) - Description
- **poDifference** (number) - Description
- **invoiceFileName** (string) - Description
- **campaigns** (array) - Description
  - **campaignId** (string) - Description
  - **campaignName** (string) - Description

#### Response Example
```json
[
  {
    "invoiceId": "string",
    "contactId": "string",
    "accountManager": "string",
    "advertiser": "string",
    "date": "string",
    "net": 0,
    "vat": 0,
    "gross": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "dateSent": "2019-08-24T14:15:22Z",
    "status": "Draft",
    "invoiceType": "string",
    "creditNoteAllocation": 0,
    "commissionType": "string",
    "deleted": true,
    "receipts": 0,
    "oustanding": 0,
    "currencySymbol": "string",
    "poNumber": "string",
    "poValue": 0,
    "poDifference": 0,
    "invoiceFileName": "string",
    "campaigns": [
      {
        "campaignId": "string",
        "campaignName": "string"
      }
    ]
  }
]
```
```

--------------------------------

### Add DNS TXT Record for Verification

Source: https://docs.optimisemedia.com/docs/publishers/faq

Configure a TXT record in your DNS settings to verify your domain. The 'Name/Host' should typically be '@' for the root domain, and the 'Value' must be your unique verification code.

```dns
Type: TXT
Name/Host: @
Value: omg-verify-########-####-####-####-############
TTL: Leave default (e.g., 3600 seconds).
```

--------------------------------

### List Placements Response Sample

Source: https://docs.optimisemedia.com/api

This is a sample JSON response for listing placements. It includes details such as placement ID, name, description, type, URL, and associated publisher and campaign information.

```json
[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": "string",
    "url": "string",
    "publisherId": 0,
    "campaignId": 0,
    "publisher": "string",
    "campaign": "string",
    "dateCreated": "string",
    "maskURL": "string",
    "typeId": 0,
    "publisherCampaignId": 0
}

]
```

--------------------------------

### Get Placement by ID

Source: https://docs.optimisemedia.com/api

Retrieves details for a specific placement using its unique ID.

```APIDOC
## GET /placements/{placementId}

### Description
Retrieves details for a specific placement using its unique ID.

### Method
GET

### Endpoint
https://public.api.optimisemedia.com/v1/placements/{placementId}

### Parameters
#### Path Parameters
- **placementId** (string) - Required - The ID of the placement to retrieve.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the placement.
- **campaignId** (integer) - The ID of the associated campaign.
- **identifier** (string) - A unique identifier for the placement.
- **description** (string) - A description of the placement.
- **thirdPartyUrl** (string) - The third-party URL associated with the placement.
- **type** (integer) - The type of the placement.
- **dateCreated** (string) - The date the placement was created.
- **userCreated** (integer) - The ID of the user who created the placement.
- **importType** (integer) - The import type of the placement.
- **isDeleted** (string) - Indicates if the placement is deleted.
- **userName** (string) - The username of the creator.
- **userSecondName** (string) - The second name of the creator.
- **clickURLTemplate** (string) - The click URL template for the placement.
- **contactID** (string) - The contact ID associated with the placement.
- **maskURL** (string) - The masked URL for the placement.
- **affiliateName** (string) - The name of the affiliate.
- **placementType** (string) - The type of the placement.
- **productId** (string) - The ID of the product associated with the placement.
- **affiliateContactId** (string) - The affiliate contact ID.
- **campaignName** (string) - The name of the campaign.
- **advertiserName** (string) - The name of the advertiser.
- **agencyId** (string) - The ID of the agency.

### Response Example
```json
{
  "id": 0,
  "campaignId": 0,
  "identifier": "string",
  "description": "string",
  "thirdPartyUrl": "string",
  "type": 0,
  "dateCreated": "string",
  "userCreated": 0,
  "importType": 0,
  "isDeleted": "string",
  "userName": "string",
  "userSecondName": "string",
  "clickURLTemplate": "string",
  "contactID": "string",
  "maskURL": "string",
  "affiliateName": "string",
  "placementType": "string",
  "productId": "string",
  "affiliateContactId": "string",
  "campaignName": "string",
  "advertiserName": "string",
  "agencyId": "string"
}
```
```

--------------------------------

### Get File

Source: https://docs.optimisemedia.com/api

Retrieve a file using its ID. Supports including sub-entries and downloading the file.

```APIDOC
## Get File

### Description
Retrieve a file

### Method
GET

### Endpoint
https://public.api.optimisemedia.com/v1/files/{id}

### Parameters
#### Path Parameters
- **id** (integer, required) - EntryId

#### Query Parameters
- **includeSubEntries** (boolean) - Include Sub Entries
- **download** (string) - download

### Responses
#### Success Response (200)
- **presignedUrl** (string) - Description

#### Error Responses
- **400** - Bad request
- **403** - Access denied
- **404** - Not found
- **500** - Access denied
```

--------------------------------

### Download Product Feed in XML Format

Source: https://docs.optimisemedia.com/docs/publishers/tools

Construct a URL to download product feeds specifically in XML format. Ensure you replace placeholders with your actual Feed ID and Affiliate ID.

```url
https://product-feeds.optimisemedia.com/feeds/%FeedID%?AID=%AID%&Format=xml
```

--------------------------------

### Shorten URL Response Sample

Source: https://docs.optimisemedia.com/api

Example of a successful response from the shorten URL endpoint, returning the shortened URL.

```json
{
  "shortUrl": "string"

}
```

--------------------------------

### Implement Universal Event Tag

Source: https://docs.optimisemedia.com/docs/advertisers/getting-started/install-tracking/universal-tracking

Add this script to every page of your campaign's journey to create a First Party Cookie (FPC) and track visitors. Ensure the 'sskey' parameter is passed if redirecting or manipulating the landing page URL.

```html
<script type="text/javascript">
OMID={MID};OPID={PID};ORef=encodeURIComponent(window.parent.location.href);
!function(){
  var a=document.createElement("script");
  a.type="text/javascript",a.async=!0,a.src="//track.omguk.com/e/qs/?action=Content&MID=" + OMID + "&PID=" + OPID + "&ref=" + ORef;
  var b=document.getElementsByTagName("body")[0];
  if(b)b.appendChild(a,b);
  else{
    var b=document.getElementsByTagName("script")[0];
    b.parentNode.insertBefore(a,b)
  }
}();
</script>
```

--------------------------------

### Create Contact Website Request Sample

Source: https://docs.optimisemedia.com/api

This is a sample JSON payload for creating a new contact website. It includes website details, media type, language, platform, country, tracking information, and traffic source.

```json
[
  {
    "id": 0,
    "guid": "string",
    "website": {
      "name": "string",
      "url": "string",
      "params": "string",
      "thirdPartyUrl": "string",
      "thirdPartyUrlS2S": true,
      "fallbackUrl": "string",
      "host": "string",
      "description": "string",
      "status": "string",
      "displayUrl": "string",
      "mobileAppRedirect": true,
      "deeplinkPrefixOverride": "string",
      "deeplinkPrefixOverrideTypeId": 0,
      "followers": 0,
      "isPrimaryAccount": true
},
    "mediaTypeId": 0,
    "languageId": 0,
    "platformId": 0,
    "countryId": 0,
    "siteVerified": "string",
    "verificationCode": "string",
    "verifyDate": "string",
    "tracked": {
      "omg": "string",
      "advertiser": 0
},
    "dedupeUrl": "string",
    "traffic": {
      "sourceId": 0,
      "volumeId": 0
}
}

]
```

--------------------------------

### Get Publisher Payment Overview

Source: https://docs.optimisemedia.com/api

Retrieves a commission status report for the Publisher, including payment details and status.

```APIDOC
## GET /publisher-payment/overview

### Description
Retrieves a commission status report for the Publisher, including payment details and status.

### Method
GET

### Endpoint
https://public.api.optimisemedia.com/v1/publisher-payment/overview

### Parameters
#### Query Parameters
- **agencyId** (integer) - Required - The agency Id
- **contactId** (integer) - Required - The contact Id
- **startYear** (integer) - Required - The Start year
- **startMonth** (integer) - Required - The Start month
- **endYear** (integer) - Required - The end year
- **endMonth** (integer) - Required - The end month
- **advertiserId** (integer) - Required - contactId of the advertiser
- **campaignId** (integer) - Required - Id of the campaign
- **paymentStatus** (string) - Required - Filter report by payment status. Enum: "Payment Sent" "Next Payment" "Advertiser Invoiced" "No Commission" "Fast" "Fast (Adjustment)" "Fast (Reversal)"

### Response
#### Success Response (200)
- **CampaignStatID** (integer)
- **BillingYear** (integer)
- **BillingMonth** (integer)
- **OptimiseCompany** (string)
- **Merchant** (string)
- **Product** (string)
- **Imp** (integer)
- **Clicks** (integer)
- **VT** (integer)
- **Currency** (string)
- **ValidatedCommission** (number)
- **OutStandingCommission** (number)
- **PaymentStatus** (string)
- **PaymentType** (string)
- **InvoiceNumber** (integer)
- **InvoiceNumberList** (string)
- **MID** (integer)
- **PID** (integer)
- **PaymentDate** (string)
- **ProductCurrencyRate** (number)
- **UV** (integer)
- **ExpressPay** (number)
- **AffiliateCurrencyRate** (number)

#### Error Response (500)
Internal error

### Response Example
```json
{
  "CampaignStatID": 0,
  "BillingYear": 0,
  "BillingMonth": 0,
  "OptimiseCompany": "string",
  "Merchant": "string",
  "Product": "string",
  "Imp": 0,
  "Clicks": 0,
  "VT": 0,
  "Currency": "string",
  "ValidatedCommission": 0,
  "OutStandingCommission": 0,
  "PaymentStatus": "string",
  "PaymentType": "string",
  "InvoiceNumber": 0,
  "InvoiceNumberList": "string",
  "MID": 0,
  "PID": 0,
  "PaymentDate": "2019-08-24T14:15:22Z",
  "ProductCurrencyRate": 0,
  "UV": 0,
  "ExpressPay": 0,
  "AffiliateCurrencyRate": 0
}
```
```

--------------------------------

### Construct Product Feed Download URL

Source: https://docs.optimisemedia.com/docs/publishers/tools

Dynamically construct a URL to download product feeds. Specify the feed format (XML, CSV, or Google Shopping) and include your Affiliate ID (AID) and the Feed ID.

```url
https://product-feeds.optimisemedia.com/%FeedID%?AID=%AID%&format=%xml/csv/google%
```

```url
https://product-feeds.optimisemedia.com/feeds/%FeedID%?AID=%AID%&Format=%xml/csv/google%
```
Tokens:
Raw