Skip to content

Main Navigation Docs API Blog

Sidebar Navigation

API Reference

Overview

Authentication

POST Login

GET Get current user info

PUT Change password

POST Logout

GET Get current user role

PUT Change login username

GET Get 2FA status

POST Setup 2FA (get secret and QR URI)

POST Verify 2FA code and enable

POST Disable 2FA

Campaigns

GET List campaigns

POST Create campaign

GET List campaigns (short info)

GET Get campaign

PUT Update campaign

DELETE Delete campaign

GET Get campaign tracking link

GET List campaign rules

POST Create campaign rule

PUT Update campaign rule

DELETE Delete campaign rule

GET List campaign paths

POST Create campaign path

PUT Update campaign path

DELETE Delete campaign path

GET List path elements

POST Create path element

PUT Reorder path elements

PUT Update path element

DELETE Delete path element

GET List campaign users

PUT Save campaign users

PUT Save campaign rotation config (bulk)

GET Get LP protect settings

PUT Update LP protect settings

Clone

POST Clone campaign

POST Clone campaign rule

POST Clone campaign path

POST Clone rotation

POST Clone offer

POST Clone landing

POST Clone traffic source

POST Clone network

Rename

PUT Rename campaign

PUT Rename rotation

PUT Rename offer

PUT Rename landing

PUT Rename traffic source

PUT Rename network

Rotations

GET List rotations

POST Create rotation

GET Get rotation

PUT Update rotation

DELETE Delete rotation

GET List campaigns using this rotation

GET List rotation paths

POST Create rotation path

PUT Update rotation path

DELETE Delete rotation path

GET List rotation rules

POST Create rotation rule

PUT Update rotation rule

DELETE Delete rotation rule

PUT Save rotation config (bulk)

Offers

GET List offers

POST Create offer

GET List networks with offer counts

GET Get offer

PUT Update offer

DELETE Delete offer

GET Get offer cap

PUT Update offer cap

POST Reset offer cap counters

POST Maximize offer cap

Landings

GET List landings

POST Create landing

GET Get landing

PUT Update landing

DELETE Delete landing

Traffic Sources

GET List traffic sources

POST Create traffic source

GET Get traffic source

PUT Update traffic source

DELETE Delete traffic source

GET Get campaign count for traffic source

Networks

GET List networks

POST Create network

GET Get network

PUT Update network

DELETE Delete network

Domains

GET List domains

POST Create domain

GET Get domain

PUT Update domain

DELETE Delete domain

PUT Set domain as default

GET Check domain SSL

Groups

GET List groups

POST Create group

GET Get group

PUT Update group

DELETE Delete group

Tags

GET List all tags

POST Create tag

PUT Update tag

DELETE Delete tag

POST Link tag to entity

POST Unlink tag from entity

POST Bulk link tag to multiple entities

GET Get tags for a specific entity

GET Get all entity-tag mappings for an entity type

Triggers

GET List triggers

POST Create trigger

GET Get trigger

PUT Update trigger

DELETE Delete trigger

GET Get trigger execution logs

Reports

POST Run multi-dimensional report

GET List available report groupings

GET List saved report presets

POST Create report preset

DELETE Delete report preset

GET List simple filter operators

GET List saved filters

POST Create saved filter

PUT Update saved filter

DELETE Delete saved filter

Stats

GET Campaign daily stats

GET Campaign detail stats

GET Conversion stats

GET Per-campaign stats

GET Per-offer stats

GET Per-landing stats

GET Per-traffic-source stats

GET Per-network stats

GET Per-rotation stats

GET Per-user stats

Logs

GET Click log

DELETE Delete clicklog data

GET Conversion log

GET Get click details

Conversions

GET List conversion statuses

GET List conversion status2 values

GET Get conversion filter options

GET Get conversion details

PUT Update conversion

DELETE Delete conversions

Users

GET List users (admin only)

POST Create user (admin only)

GET Get user (admin only)

PUT Update user (admin only)

DELETE Delete user (admin only)

PUT Reset user password (admin only)

PUT Regenerate user API key (admin only)

GET List user permissions (admin only)

PUT Save user permissions (admin only)

GET Activity log (admin only)

GET Log event types (admin only)

Notes

GET Get entity note

PUT Save entity note

DELETE Delete entity note

POST Upload note image

Custom Columns

GET List custom columns

POST Create custom column

GET Get custom column

PUT Update custom column

DELETE Delete custom column

Settings

GET Get bot cost setting

PUT Set bot cost setting

GET Get CORS origins

PUT Set CORS origins

GET Get clearings settings

PUT Set clearings settings

GET Get URL customization

PUT Set URL customization

GET Get tracking link templates

GET Get system info

PUT Update system info

POST Clear stats data

Bulk Operations

POST Bulk change campaign cost

POST Bulk change campaign group

POST Bulk change campaign traffic source

POST Bulk change campaign domain

POST Bulk change campaign setting

POST Bulk change offer caps

POST Bulk change offer group

POST Bulk change offer country

POST Bulk change landing group

POST Bulk change landing language

Restore

PATCH Restore deleted campaign

PATCH Restore deleted offer

PATCH Restore deleted landing

PATCH Restore deleted rotation

PATCH Restore deleted traffic source

PATCH Restore deleted network

Pause

PUT Pause rotation path

PUT Unpause rotation path

Import/Export

GET Export data

POST Import data

Backup

GET List backup jobs

POST Create backup job

DELETE Delete backup

GET Get backup status

Files

GET List files

POST Write file

DELETE Delete file

GET Read file content

POST Upload file

GET Download file

PUT Rename file

POST Create directory

POST Server-side URL fetch

CSV Export

POST Enqueue CSV export job

GET List CSV export jobs

POST Dequeue and process next CSV job

GET List CSV export files

DELETE Delete CSV file

Cost Update

GET Update click cost (GET)

POST Update click cost (POST)

POST Bulk update costs by campaign and date range

Trends

GET Click trends

GET Conversion trends

GET Revenue trends

Lookups

GET List countries

GET List languages

GET List timezones

GET List available tokens

GET List date presets

GET List currencies

GET List device types

GET List device brands

GET List device models for a brand

GET List browsers

GET List operating systems

GET List device languages

GET List GeoIP countries

GET List GeoIP cities

GET List GeoIP regions

GET List continents

GET List states

GET List ISP names

GET List ISP organizations

GET List connection types

Templates

GET List traffic source templates

GET List network templates

Currency

GET List exchange rates

GET Convert currency

Monitor

GET System info

GET Background tasks

List backup jobs

GET

/api/backup

Authorizations

ApiKeyHeader

Type

API Key (header: X-Api-Key)

Responses

Backup job list

GET

/api/backup

Playground

Authorization

ApiKeyHeader

Samples

Powered by VitePress OpenAPI

Pager

Previous page POST Import data

Next page POST Create backup job