Topsort

https://docs.topsort.com
Admin
Topsort is an auction-based advertising platform that enables marketplaces to develop and scale...
Tokens:727
Snippets:8
Trust Score:9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Create advertising campaign via API

Source: https://docs.topsort.com/

Initialize a new advertising campaign with a specified budget and type.

```cURL
curl --request POST \
  --url https://api.topsort.com/v2/campaigns \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My First Campaign",
    "budget": 1000,
    "type": "sponsored_listings",
    "startDate": "2024-01-01"
  }'
```

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

### Upload products to catalog via API

Source: https://docs.topsort.com/

Use the Catalog API to register products in your inventory for advertising.

```cURL
curl --request POST \
  --url https://api.topsort.com/v2/products \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "products": [
      {
        "id": "product-123",
        "name": "Example Product",
        "price": 29.99,
        "imageUrl": "https://example.com/product.jpg",
        "category": "electronics"
      }
    ]
  }'
```

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

### Request ad placements via auction system

Source: https://docs.topsort.com/

Submit a request to the auction system to retrieve ad slots for specific products.

```cURL
curl --request POST \
  --url https://api.topsort.com/v2/auctions \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "slots": 3,
    "products": {
      "ids": ["product-123", "product-456"]
    },
    "category": {
      "id": "electronics"
    }
  }'
```

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

### Track user interactions and conversions

Source: https://docs.topsort.com/

Log events such as clicks or conversions to the analytics system.

```cURL
curl --request POST \
  --url https://api.topsort.com/v2/events \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "events": [
      {
        "type": "click",
        "productId": "product-123",
        "resolvedBidId": "bid-456",
        "occurredAt": "2024-10-12T17:30:00Z"
      }
    ]
  }'
```
Tokens:
Raw