Opportunity Campaigns
opportunities-campaignsRetrieve campaigns for a Merkl opportunity by ID, with optional filters for test, point, token types, and sub-campaign exclusion.
Instructions
GET /v4/opportunities/{id}/campaigns
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The id of the opportunity. Pattern: (([0-9]*)-([0-9A-Z]*)-(0x([0-9A-Za-z])+))|([0-9]{1,20}) | |
| test | No | Include test campaigns | |
| point | No | Include point campaigns | |
| campaigns | No | Include campaign data. Will slow down the request | |
| tokenTypes | No | Filter by token type. Use POINT to include point campaigns and PRETGE to include preTGE campaigns. | |
| excludeSubCampaigns | No | Exclude sub-campaigns from the results |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| opportunity | Yes | Opportunity with related campaigns or null if not found |