### Install Node.js Modules

Source: https://github.com/performancehorizongroup/apidocs/blob/master/README.md

Installs the necessary Node.js modules for the project. Run this in the repository's root directory.

```bash
npm install
```

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

### Install Node.js, NPM, and NVM on macOS

Source: https://github.com/performancehorizongroup/apidocs/blob/master/README.md

Installs Node.js, NPM, and NVM using Homebrew. Ensure Homebrew is installed first.

```bash
brew install node npm nvm
```

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

### Standard Pagination - Page 2

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Example of fetching the second page of results using offset and limit parameters. Ensure your Authorization header is included.

```bash
curl -X GET "https://api.partnerize.com/user.json?limit=100&offset=100" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Standard Pagination - Page 1

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Example of fetching the first page of results using offset and limit parameters. The response includes pagination details.

```bash
curl -X GET "https://api.partnerize.com/user.json?limit=100&offset=0" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Watch for Changes and Live Preview API Docs

Source: https://github.com/performancehorizongroup/apidocs/blob/master/README.md

Starts a watch process for API Blueprint files and a preview server with automatic browser reloading. Ensure 'make' is run before preview updates.

```bash
npm run watch

# start preview server (manual reload to view changes)
npm run preview

# or, start preview server and watch for changes (automatically reload)
npm run preview -- --watch
```

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

### Install apiaryio Ruby Gem

Source: https://github.com/performancehorizongroup/apidocs/blob/master/README.md

Installs the apiaryio Ruby Gem. Use 'sudo' if not using RVM or rbenv.

```ruby
gem install apiaryio
```

```ruby
sudo gem install apiaryio
```

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

### Create Voucher Codes (Batch)

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates multiple voucher codes in a batch for a given campaign. Specifies the voucher code, start and end dates, and associated commission groups.

```bash
# Create voucher codes (batch)
curl -X POST "https://api.partnerize.com/campaign/10l176/voucher_code.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "voucher_codes": [
      {
        "voucher_code": "SUMMER20",
        "start_date": "2024-06-01 00:00:00",
        "end_date": "2024-08-31 23:59:59",
        "commission_groups": ["10l169"]
      }
    ]
  }'
```

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

### Get Available Alert Groups

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all available alert groups for managing notification subscriptions. Requires authentication.

```bash
# Get all available alert groups
curl -X GET "https://api.partnerize.com/alerts/group.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Alerts and Notifications - Get Notifications

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves all notifications for the current user.

```APIDOC
## GET /alerts/notification.json

### Description
Retrieves all notifications for the current user.

### Method
GET

### Endpoint
https://api.partnerize.com/alerts/notification.json
```

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

### Get User Notifications

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves all notifications currently subscribed to by the authenticated user. Requires authentication.

```bash
# Get all notifications for current user
curl -X GET "https://api.partnerize.com/alerts/notification.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Alerts and Notifications - Get Messages

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves user alert messages with optional pagination.

```APIDOC
## GET /alerts/messages.json

### Description
Retrieves user alert messages with optional pagination.

### Method
GET

### Endpoint
https://api.partnerize.com/alerts/messages.json

### Request Body
- **limit** (integer) - Optional - The maximum number of messages to retrieve.
- **offset** (integer) - Optional - The number of messages to skip.
```

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

### Alerts and Notifications - Get Alert Groups

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all available alert groups.

```APIDOC
## GET /alerts/group.json

### Description
Retrieves a list of all available alert groups.

### Method
GET

### Endpoint
https://api.partnerize.com/alerts/group.json
```

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

### Get User Alert Messages

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves alert messages for the current user, with options for limiting and offsetting results. Requires authentication and a JSON payload for parameters.

```bash
# Get user alert messages
curl -X GET "https://api.partnerize.com/alerts/messages.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 10, "offset": 0 }'
```

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

### List Promotional Methods

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches a list of all promotional methods. Ensure the Authorization header is correctly set.

```bash
curl -X GET "https://api.partnerize.com/reference/promotional_method.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Build API Docs on Ubuntu

Source: https://github.com/performancehorizongroup/apidocs/blob/master/README.md

Executes a build script for the API documentation on Ubuntu systems.

```bash
./ubuntu-build
```

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

### Create User and Publisher Account

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Simultaneously creates a user account and an associated publisher account. Requires application key for authentication.

```bash
curl -X POST "https://api.partnerize.com/user.json" \
  -H "Authorization: Basic $(echo -n 'my_application_key:' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "user_name": "newpubuser",
    "password": "securepassword",
    "email": "pub@example.com",
    "publisher": {
      "account_name": "My Publisher Site",
      "entity_terms_id": 252
    }
  }'
```

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

### Preview API Docs Locally on macOS

Source: https://github.com/performancehorizongroup/apidocs/blob/master/README.md

Builds and previews the API documentation locally. This command opens the documentation in your default browser.

```bash
npm run preview
```

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

### Create Campaign

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new campaign with specified details including advertiser ID, title, description, currency, cookie period, and default commission.

```bash
# Create a campaign
curl -X POST "https://api.partnerize.com/campaign.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "advertiser_id": "10l110",
    "title": "Summer Sale 2024",
    "description": "Promote our summer collection",
    "default_currency": "GBP",
    "cookie_period": 30,
    "default_commission": "5.00"
  }'
```

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

### List Payment Methods

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

This endpoint lists all available payment methods. Basic authentication is required.

```bash
curl -X GET "https://api.partnerize.com/reference/payment_method.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List All Currencies

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches a list of all supported currencies. Ensure your Authorization header is properly configured.

```bash
curl -X GET "https://api.partnerize.com/reference/currency.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Create Publisher

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new publisher with specified account details. Ensure all required fields like account_name, entity_id, network_id, and entity_terms_id are provided.

```bash
# Create a publisher
curl -X POST "https://api.partnerize.com/user/publisher.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "account_name": "newpublisher123",
    "entity_id": 1,
    "network_id": "1l1000003",
    "entity_terms_id": 252
  }'
```

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

### Authenticate API Requests with Basic Auth

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Demonstrates how to encode application and user API keys for Basic Authentication. This is required for most API requests.

```bash
# Encode credentials
CREDENTIALS=$(echo -n "my_application_key:my_user_api_key" | base64)

# Make an authenticated request
curl -X GET "https://api.partnerize.com/user.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Accept-Encoding: gzip"
```

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

### List Advertiser Conversions with Filters

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetch conversion data for a campaign, supporting filters by currency, publisher ID, and pagination using a cursor. This allows for detailed analysis of conversion performance with specific criteria.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_advertiser/campaign/10l176/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&currency=GBP&publisher_id=1l1007802&pagination=cursor&limit=300" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Create a New Advertiser

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new advertiser account on the network. Requires Basic Authentication and a JSON payload with advertiser details.

```bash
curl -X POST "https://api.partnerize.com/user/advertiser.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "account_name": "newadvertiser123",
    "title": "New Advertiser Co",
    "default_currency": "GBP",
    "country": "GB"
  }'
```

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

### Create a User

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new user account. This endpoint only requires the `application_key` for authentication.

```APIDOC
## Create a User

This is the only endpoint that does not require a `user_api_key` — only the `application_key` is needed in the Basic Auth username field (password can be empty).

```bash
curl -X POST "https://api.partnerize.com/user.json" \
  -H "Authorization: Basic $(echo -n 'my_application_key:' | base64)" \
  -H "Content-Type: application/json" \
  -d '{ 
    "user_name": "newuser123",
    "password": "securepassword",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com"
  }'

# Response includes the new user_api_key for future requests
# {
#   "user": {
#     "user_id": "11l19000",
#     "user_name": "newuser123",
#     "user_api_key": "AbCd1234"
#   }
# }
```
```

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

### Create a New User Account

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new user account. This endpoint only requires the application key for authentication and does not need a user API key.

```bash
curl -X POST "https://api.partnerize.com/user.json" \
  -H "Authorization: Basic $(echo -n 'my_application_key:' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "user_name": "newuser123",
    "password": "securepassword",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com"
  }'
```

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

### List Publisher Conversions with Cursor Pagination

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetch conversion data for a publisher, utilizing cursor-based pagination for efficient retrieval of large datasets. Specify the date range and limit for the results.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&pagination=cursor&limit=300" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Retrieve User Accounts and Permissions

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches all network, advertiser, and publisher accounts accessible by the authenticated user, along with their associated permissions. Requires Basic Authentication.

```bash
curl -X GET "https://api.partnerize.com/user/account.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Conversion Types

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve a list of all conversion types. Include your credentials in the Authorization header.

```bash
curl -X GET "https://api.partnerize.com/reference/conversion_type.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Authentication

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Demonstrates how to authenticate API requests using HTTP Basic Auth with application and user API keys.

```APIDOC
## Authentication

Authenticate using HTTP Basic Auth by Base64-encoding `application_key:user_api_key` and passing it in the `Authorization` header for every request (except user creation).

```bash
# Encode credentials
CREDENTIALS=$(echo -n "my_application_key:my_user_api_key" | base64)

# Make an authenticated request
curl -X GET "https://api.partnerize.com/user.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Accept-Encoding: gzip"

# Expected response
# {
#   "user": {
#     "user_id": "11l16829",
#     "user_name": "johndoe",
#     "network_id": "1l1000003",
#     "network_name": "PHG",
#     "user_api_key": "ZMEt5ca8"
#   }
# }
```
```

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

### Cursor-Based Pagination - First Page

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetch the first page of results using cursor-based pagination. No cursor_id is needed for the initial request.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&limit=300&pagination=cursor" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Create a User and Publisher in One Request

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates both a user account and an associated publisher account simultaneously.

```APIDOC
### Create a User and Publisher in One Request

Creates both a user account and an associated publisher account simultaneously.

```bash
curl -X POST "https://api.partnerize.com/user.json" \
  -H "Authorization: Basic $(echo -n 'my_application_key:' | base64)" \
  -H "Content-Type: application/json" \
  -d '{ 
    "user_name": "newpubuser",
    "password": "securepassword",
    "email": "pub@example.com",
    "publisher": {
      "account_name": "My Publisher Site",
      "entity_terms_id": 252
    }
  }'
```
```

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

### List All Countries

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

This endpoint retrieves a list of all countries. Basic authentication is required.

```bash
curl -X GET "https://api.partnerize.com/reference/country.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Create an Advertiser

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new advertiser within the Partnerize platform.

```APIDOC
## Create an Advertiser

```bash
curl -X POST "https://api.partnerize.com/user/advertiser.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{ 
    "account_name": "newadvertiser123",
    "title": "New Advertiser Co",
    "default_currency": "GBP",
    "country": "GB"
  }'
```
```

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

### List All Advertisers with Pagination

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all advertisers visible to the authenticated user. Supports pagination using `limit` and `offset` parameters. Requires Basic Authentication.

```bash
curl -X GET "https://api.partnerize.com/user/advertiser.json?limit=100&offset=0" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List All Verticals

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve a list of all available verticals. Requires basic authentication.

```bash
curl -X GET "https://api.partnerize.com/reference/vertical.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Aggregate Publisher Overview by Primary

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves an aggregated overview of publisher performance for all campaigns within a specified date range. Requires authentication.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/overview/primary/range/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&timezone=Europe/London" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Request Campaign Access for Publisher

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Use this endpoint to request access to one or more campaigns for a given publisher. Provide the campaign_id and optionally the terms_id for each campaign you wish to join.

```bash
curl -X POST "https://api.partnerize.com/user/publisher/1l1007802/campaign/a.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "campaigns": [
      { "campaign_id": "10l176", "terms_id": "111111l8" },
      { "campaign_id": "10l199" }
    ]
  }'
```

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

### List Campaigns

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all campaigns. Requires valid authorization credentials.

```bash
# List all campaigns
curl -X GET "https://api.partnerize.com/campaign.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Approved Campaign Tracking Links for Publisher

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches the tracking links for campaigns that a publisher has been approved for. This allows publishers to obtain the necessary links for promotion.

```bash
curl -X GET "https://api.partnerize.com/user/publisher/1l1007802/campaign/a/tracking.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List All Commissions

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves all commissions across all levels (campaign, publisher, group) for a given campaign.

```bash
# All commissions (all levels combined)
curl -X GET "https://api.partnerize.com/campaign/10l176/commission.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Creative Types

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches a list of all creative types. Ensure your credentials are provided in the Authorization header.

```bash
curl -X GET "https://api.partnerize.com/reference/creative_type.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Retrieve Next Page of Publisher Conversions

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Use the cursor_id obtained from a previous conversion report response to fetch the subsequent page of results. This is crucial for paginating through extensive conversion data.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&limit=300&cursor_id=10325942995" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Supported Timezones

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve a list of supported timezones. The Authorization header must be included.

```bash
curl -X GET "https://api.partnerize.com/reference/timezone.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Advertiser Conversions with Natural Language Date Range

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve conversion data for a campaign using a natural language date range, such as 'last 30 days'. This simplifies date filtering for quick reporting.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_advertiser/campaign/10l176/conversion.json?text_date=last+30+days" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Publishers

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all publishers associated with the account. Requires valid authorization credentials.

```bash
# List all publishers
curl -X GET "https://api.partnerize.com/user/publisher.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Aggregate Advertiser Conversions with Multi-Pivot Filters

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Create an aggregated report of advertiser conversions, allowing for multiple pivot filters such as country and product. This enables detailed segmentation of conversion data.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_advertiser/campaign/10l176/overview/country/range/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&multipivot[country][]=US&multipivot[country][]=JP&multipivot[product][]=Flights" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Voucher Codes

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves all voucher codes associated with a specific campaign.

```bash
# List all voucher codes for a campaign
curl -X GET "https://api.partnerize.com/campaign/10l176/voucher_code.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Export Conversion Report as CSV with Publisher Filter

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Exports conversion data for a campaign, filtered by publisher, within a date range. Supports currency specification. Requires authentication.

```bash
# Export conversion report as CSV (with publisher filter)
curl -X GET "https://api.partnerize.com/reporting/export/export/conversion.csv?campaign_id=10l176&publisher_id=1l1007802&start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&currency=GBP" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Create User Notification Subscription

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new notification subscription for the current user, linking an alert group to a notifier. Requires authentication and a JSON payload specifying the alert group and notifier IDs.

```bash
# Create a new notification (email notifier for campaign activity)
curl -X POST "https://api.partnerize.com/alerts/notification/11l16829.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "alert_alert_group_id": 70,
    "alert_notifier_id": 4
  }'
```

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

### Create Campaign Creatives

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates one or more new creatives for a specified campaign. Requires authentication and a JSON payload detailing the creatives.

```bash
# Create multiple creatives
curl -X POST "https://api.partnerize.com/campaign/10l176/creative.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "creatives": [
      {
        "creative_type_id": 1,
        "title": "Banner 728x90",
        "description": "Main leaderboard banner",
        "width": 728,
        "height": 90,
        "url": "https://cdn.example.com/banner-728x90.jpg"
      }
    ]
  }'
```

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

### Update Advertiser

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Use this endpoint to update existing advertiser details. Ensure the Authorization header is correctly set.

```bash
curl -X POST "https://api.partnerize.com/user/advertiser/10l110.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "advertiser_id": "10l110",
    "title": "Updated Advertiser Name"
  }'
```

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

### Create Campaign Filter Set

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Saves a new filter set for a campaign, including a name, default status, and filter data. Requires authentication and a JSON payload.

```bash
# Create a new filter set
curl -X POST "https://api.partnerize.com/report/campaign/10l176/filter_sets.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "UK Traffic Only",
    "is_default": false,
    "data": "{\"country\":[\"GB\"],\"status\":[\"approved\"]}" 
  }'
```

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

### List Campaigns for Publisher

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve a list of all campaigns associated with a specific publisher that have an approved status. This is useful for understanding a publisher's current campaign participation.

```bash
curl -X GET "https://api.partnerize.com/user/publisher/1l1007802/campaign/a.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Retrieve Campaign

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches details for a specific campaign using its campaign ID.

```bash
# Retrieve campaign 10l176
curl -X GET "https://api.partnerize.com/campaign/10l176.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Retrieve or Update an Advertiser

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches details for a specific advertiser by ID or updates an existing advertiser's information. Requires Basic Authentication.

```bash
# Retrieve
curl -X GET "https://api.partnerize.com/user/advertiser/10l110.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Aggregate Advertiser Conversions by Country and Commission

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Generate an aggregated report of advertiser conversions, pivoted by country and sorted by commission value. This report helps identify top-performing countries based on commission earned.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_advertiser/campaign/10l176/overview/country/range/commission.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&convert_currency=USD" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List All Advertisers

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all advertisers on the network visible to the authenticated user, supporting pagination.

```APIDOC
## List All Advertisers

Returns all advertisers on the network visible to the authenticated user, with optional pagination.

```bash
curl -X GET "https://api.partnerize.com/user/advertiser.json?limit=100&offset=0" \
  -H "Authorization: Basic $CREDENTIALS"

# Response
# {
#   "count": 86,
#   "limit": 100,
#   "offset": 0,
#   "execution_time": "0.23640 seconds",
#   "advertisers": [
#     { "advertiser": { "advertiser_id": "10l110", "account_name": "my-brand", ... } }
#   ]
# }
```
```

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

### Retrieve Authenticated User Details

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Fetches the details of the currently authenticated user. Requires Basic Authentication.

```bash
curl -X GET "https://api.partnerize.com/user.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Advertiser Clicks for Campaign

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve a list of all click events for a specific campaign within a defined date range. This report is essential for analyzing click performance.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_advertiser/campaign/10l176/click.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Create Commission Rules

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates multiple commission rules in a single API call. Supports defining rules for campaign and participation levels with specified values and types.

```bash
# Create commission rules (multiple in one call)
curl -X POST "https://api.partnerize.com/campaign/10l176/commission.json" \
  -H "Authorization: Basic $CREDENTIALS" \
  -H "Content-Type: application/json" \
  -d '{
    "commissions": [
      {
        "reference_type": "campaign",
        "reference_id": "10l176",
        "value": "5.00",
        "type": "percentage",
        "promotion": "n"
      },
      {
        "reference_type": "participation",
        "reference_id": "1l1007802",
        "value": "7.50",
        "type": "percentage",
        "promotion": "n"
      }
    ]
  }'
```

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

### Alerts and Notifications - Create Notification

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new notification subscription for a user, such as an email notifier for campaign activity.

```APIDOC
## POST /alerts/notification/{notification_id}.json

### Description
Creates a new notification subscription for a user.

### Method
POST

### Endpoint
https://api.partnerize.com/alerts/notification/11l16829.json

### Request Body
- **alert_alert_group_id** (integer) - Required - The ID of the alert group.
- **alert_notifier_id** (integer) - Required - The ID of the notifier.
```

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

### Aggregate publisher overview by primary (all campaigns)

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves an aggregated overview of publisher performance for all campaigns, filtered by primary data, within a specified date range.

```APIDOC
## GET /reporting/report_publisher/publisher/{publisher_id}/overview/primary/range/conversion.json

### Description
Retrieves an aggregated overview of publisher performance for all campaigns, filtered by primary data, within a specified date range.

### Method
GET

### Endpoint
https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/overview/primary/range/conversion.json

### Query Parameters
- **start_date** (string) - Required - The start date for the reporting period.
- **end_date** (string) - Required - The end date for the reporting period.
- **timezone** (string) - Optional - The timezone to use for date calculations.
```

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

### Standard Offset/Limit Pagination

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves data using standard offset and limit parameters, commonly used for paginating lists of resources like users.

```APIDOC
## GET /{resource}.json?limit={limit}&offset={offset}

### Description
Retrieves a paginated list of resources using offset and limit parameters. Includes hypermedia links for navigation.

### Method
GET

### Endpoint
/{resource}.json

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of items to return per page. Defaults to a system-defined value.
- **offset** (integer) - Optional - The number of items to skip from the beginning of the list. Defaults to 0.

### Response
#### Success Response (200)
- **count** (integer) - The total number of items available.
- **limit** (integer) - The limit applied to this page.
- **offset** (integer) - The offset applied to this page.
- **hypermedia** (object) - Contains pagination links.
  - **pagination** (object)
    - **total_page_count** (integer) - The total number of pages.
    - **first_page** (string) - URL to the first page.
    - **last_page** (string) - URL to the last page.
    - **next_page** (string) - URL to the next page.
    - **previous_page** (string) - URL to the previous page.

### Request Example
```bash
# Page 1
curl -X GET "https://api.partnerize.com/user.json?limit=100&offset=0" \
  -H "Authorization: Basic $CREDENTIALS"

# Page 2
curl -X GET "https://api.partnerize.com/user.json?limit=100&offset=100" \
  -H "Authorization: Basic $CREDENTIALS"
```

### Response Example
```json
{
  "count": 1500,
  "limit": 100,
  "offset": 0,
  "hypermedia": {
    "pagination": {
      "total_page_count": 15,
      "first_page": "/user.json?limit=100&offset=0",
      "last_page": "/user.json?limit=100&offset=1400",
      "next_page": "/user.json?limit=100&offset=100",
      "previous_page": null
    }
  }
}
```
```

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

### List Campaign Filter Sets

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all saved filter sets for a specific campaign. Requires authentication.

```bash
# List all filter sets for a campaign
curl -X GET "https://api.partnerize.com/report/campaign/10l176/filter_sets.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Publisher Clicks

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve click data attributed to a specific publisher within a given date range. This report helps publishers monitor their click performance across campaigns.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/click.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Publisher Click and Conversion Reports

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Provides access to publisher-level click and conversion reports, supporting date ranges and cursor-based pagination.

```APIDOC
## GET /reporting/report_publisher/publisher/{publisher_id}/click.json

### Description
Retrieves publisher click reports for a specified date range.

### Method
GET

### Endpoint
/reporting/report_publisher/publisher/{publisher_id}/click.json

### Parameters
#### Path Parameters
- **publisher_id** (string) - Required - The ID of the publisher.

#### Query Parameters
- **start_date** (string) - Required - The start date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
- **end_date** (string) - Required - The end date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
```

```APIDOC
## GET /reporting/report_publisher/publisher/{publisher_id}/conversion.json

### Description
Retrieves publisher conversion reports with cursor-based pagination.

### Method
GET

### Endpoint
/reporting/report_publisher/publisher/{publisher_id}/conversion.json

### Parameters
#### Path Parameters
- **publisher_id** (string) - Required - The ID of the publisher.

#### Query Parameters
- **start_date** (string) - Required - The start date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
- **end_date** (string) - Required - The end date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
- **pagination** (string) - Optional - Type of pagination to use (e.g., "cursor").
- **limit** (integer) - Optional - The maximum number of results to return per page.
- **cursor_id** (string) - Optional - The cursor ID for retrieving the next page of results.
```

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

### List Campaign Creatives

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves a list of all creatives associated with a specific campaign. Requires authentication.

```bash
# List all creatives for campaign
curl -X GET "https://api.partnerize.com/campaign/10l176/creative.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Publisher-Level Commissions

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves commission rules defined at the publisher participation level for a specific campaign and publisher.

```bash
# Publisher-level commissions
curl -X GET "https://api.partnerize.com/campaign/10l176/publisher/1l1007802/commission.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Download Report with Email Notification

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Downloads a report in CSV format and sends an email notification upon completion, suitable for large exports. Requires authentication.

```bash
curl -X GET "https://api.partnerize.com/reporting/report_advertiser/campaign/10l176/overview/primary/range/conversion.csv?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&limit=0&complete_email=me@example.com&export_reference=JanSales" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### View Campaign Tracking Code

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieve the tracking code snippets for a specific campaign. This includes both pixel tracking for web-based conversions and API tracking for server-to-server integration.

```bash
curl -X GET "https://api.partnerize.com/campaign/10l176/tracking.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### List Reference Data

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves lists of various platform reference entities, such as verticals, currencies, countries, and more.

```APIDOC
## GET /reference/{entity}.json

### Description
Retrieves a list of available entities for a given reference type.

### Method
GET

### Endpoint
/reference/{entity}.json

### Parameters
#### Path Parameters
- **entity** (string) - Required - The type of reference data to retrieve (e.g., vertical, currency, country, timezone, creative_type, payment_method, conversion_type, promotional_method).

### Response
#### Success Response (200)
(Response structure not explicitly defined in source, but typically returns a JSON array of reference objects.)

### Examples
- List all verticals: `GET /reference/vertical.json`
- List all currencies: `GET /reference/currency.json`
- List all countries: `GET /reference/country.json`
- List supported timezones: `GET /reference/timezone.json`
- List creative types: `GET /reference/creative_type.json`
- List payment methods: `GET /reference/payment_method.json`
- List conversion types: `GET /reference/conversion_type.json`
- List promotional methods: `GET /reference/promotional_method.json`
```

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

### List Campaign-Level Commissions

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves commission rules defined at the campaign level for a specific campaign.

```bash
# Campaign-level commissions
curl -X GET "https://api.partnerize.com/campaign/10l176/campaign/10l176/commission.json" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Retrieve User Accounts

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves the network, advertiser, and publisher accounts accessible by the authenticated user, along with their permissions.

```APIDOC
### Retrieve User Accounts

Returns the network, advertiser, and publisher accounts accessible by the authenticated user with their permissions.

```bash
curl -X GET "https://api.partnerize.com/user/account.json" \
  -H "Authorization: Basic $CREDENTIALS"

# Response includes all linked accounts and their permissions
# {
#   "user_accounts": [
#     { "network": { "network_id": "1l1000003", "network_name": "PHG" }, "permissions": [...] },
#     { "publisher": { "publisher_id": "1l1007802", "account_name": "My Blog" }, "permissions": [...] }
#   ]
# }
```
```

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

### Advertiser Click and Conversion Reports

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Provides access to advertiser-level click and conversion reports for a campaign, with options for date ranges and filtering.

```APIDOC
## GET /reporting/report_advertiser/campaign/{campaign_id}/click.json

### Description
Lists all clicks for a campaign within a specified date range.

### Method
GET

### Endpoint
/reporting/report_advertiser/campaign/{campaign_id}/click.json

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The ID of the campaign.

#### Query Parameters
- **start_date** (string) - Required - The start date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
- **end_date** (string) - Required - The end date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
```

```APIDOC
## GET /reporting/report_advertiser/campaign/{campaign_id}/conversion.json

### Description
Lists conversions with filters and cursor pagination for a campaign.

### Method
GET

### Endpoint
/reporting/report_advertiser/campaign/{campaign_id}/conversion.json

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The ID of the campaign.

#### Query Parameters
- **start_date** (string) - Required - The start date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
- **end_date** (string) - Required - The end date for the report in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
- **currency** (string) - Optional - Filter by currency.
- **publisher_id** (string) - Optional - Filter by publisher ID.
- **pagination** (string) - Optional - Type of pagination to use (e.g., "cursor").
- **limit** (integer) - Optional - The maximum number of results to return per page.
- **text_date** (string) - Optional - A natural language date range (e.g., "last 30 days").
```

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

### Approve / Reject Conversion Events

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Allows for the approval or rejection of conversion events associated with a campaign.

```APIDOC
## POST /campaign/{campaign_id}/conversion.json

### Description
Approves or rejects conversion events for a campaign.

### Method
POST

### Endpoint
/campaign/{campaign_id}/conversion.json

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The ID of the campaign.

### Request Body
- **conversions** (array) - Required - A list of conversions to process.
  - **conversion_id** (string) - Required - The ID of the conversion.
  - **status** (string) - Required - The new status for the conversion (e.g., "approved", "rejected", "pending").
  - **reject_reason** (string) - Optional - The reason for rejecting the conversion, if applicable.
  - **conversion_reference_id** (string) - Required - The reference ID of the conversion.
  - **conversion_item_id** (string) - Required - The item ID of the conversion.
```

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

### Cursor-Based Pagination

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Retrieves data using cursor-based pagination, suitable for high-volume reporting endpoints where sequential access is needed.

```APIDOC
## GET /{resource}.json?pagination=cursor&cursor_id={cursor_id}

### Description
Retrieves paginated data using a cursor ID, ideal for large datasets. The cursor ID is obtained from the `next_page` hypermedia link of the previous response.

### Method
GET

### Endpoint
/{resource}.json

### Parameters
#### Query Parameters
- **start_date** (string) - Required - The start date for the report (ISO 8601 format).
- **end_date** (string) - Required - The end date for the report (ISO 8601 format).
- **limit** (integer) - Optional - The number of items to return per page. Defaults to a system-defined value.
- **pagination** (string) - Required - Set to `cursor` to enable cursor-based pagination.
- **cursor_id** (string) - Optional - The cursor ID from the previous response's `next_page` link. Omit for the first request.

### Response
#### Success Response (200)
(Response structure not explicitly defined in source, but typically includes data and hypermedia with pagination details including a `cursor_id` for the next page.)

### Request Example
```bash
# First page (no cursor_id needed)
curl -X GET "https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&limit=300&pagination=cursor" \
  -H "Authorization: Basic $CREDENTIALS"

# Subsequent pages (pass cursor_id from previous response)
curl -X GET "https://api.partnerize.com/reporting/report_publisher/publisher/1l1007802/conversion.json?start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&limit=300&cursor_id=10325942995" \
  -H "Authorization: Basic $CREDENTIALS"
```
```

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

### Export Conversion Items CSV

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Exports detailed conversion item data, including individual line-item details, for a campaign within a date range. Can be used for large exports with email notifications. Requires authentication.

```bash
# Export conversion items CSV (includes individual line-item detail)
curl -X GET "https://api.partnerize.com/reporting/export/export/conversion_item.csv?campaign_id=10l176&start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&limit=0&complete_email=analyst@example.com" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Filter Sets - List Filter Sets

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Lists all filter sets saved for a specific campaign.

```APIDOC
## GET /report/campaign/{campaign_id}/filter_sets.json

### Description
Lists all filter sets saved for a specific campaign.

### Method
GET

### Endpoint
https://api.partnerize.com/report/campaign/10l176/filter_sets.json
```

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

### Export Click Report as CSV

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Exports click data for a specified campaign within a date range, with options for delimiter and encoding. Requires authentication.

```bash
# Export click report as CSV
curl -X GET "https://api.partnerize.com/reporting/export/export/click.csv?campaign_id=10l176&start_date=2024-01-01T00:00:00Z&end_date=2024-01-31T23:59:59Z&delimiter=comma&encoding=UTF-8" \
  -H "Authorization: Basic $CREDENTIALS"
```

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

### Filter Sets - Create Filter Set

Source: https://context7.com/performancehorizongroup/apidocs/llms.txt

Creates a new filter set for a campaign, which can be used to save and manage report filters.

```APIDOC
## POST /report/campaign/{campaign_id}/filter_sets.json

### Description
Creates a new filter set for a campaign.

### Method
POST

### Endpoint
https://api.partnerize.com/report/campaign/10l176/filter_sets.json

### Request Body
- **name** (string) - Required - The name of the filter set.
- **is_default** (boolean) - Optional - Indicates if this is the default filter set.
- **data** (string) - Required - A JSON string representing the filter data (e.g., `{"country":["GB"],"status":["approved"]}`).
```