Campaigns
List Campaigns
Parameters
Response
{
"campaigns": [
{
"id": "campaign123",
"name": "Summer Collection",
"status": "active",
"startDate": "2024-06-01T00:00:00Z",
"endDate": "2024-08-31T23:59:59Z",
"budget": 10000,
"createdAt": "2024-03-14T12:00:00Z"
}
]
}
Get Campaign
Parameters
Response
Detailed campaign information
{
"id": "campaign123",
"name": "Summer Collection",
"status": "active",
"startDate": "2024-06-01T00:00:00Z",
"endDate": "2024-08-31T23:59:59Z",
"budget": 10000,
"metrics": {
"reach": 50000,
"engagement": 2500,
"clicks": 1000
},
"createdAt": "2024-03-14T12:00:00Z",
"updatedAt": "2024-03-14T12:00:00Z"
}
Create Campaign
Parameters
Request Body
{
"name": "Summer Collection",
"startDate": "2024-06-01T00:00:00Z",
"endDate": "2024-08-31T23:59:59Z",
"budget": 10000,
"targetRegions": ["US", "CA"],
"objectives": ["brand_awareness", "sales"],
"creatorRequirements": {
"minFollowers": 10000,
"minEngagementRate": 0.02
}
}
Response
{
"id": "campaign123",
"name": "Summer Collection",
"status": "draft",
"createdAt": "2024-03-14T12:00:00Z"
}
Update Campaign
Update an existing campaign
Parameters
Request Body
{
"name": "Updated Summer Collection",
"budget": 15000,
"status": "active"
}
Response
{
"message": "Campaign updated successfully",
"campaign": {
"id": "campaign123",
"name": "Updated Summer Collection",
"budget": 15000,
"status": "active",
"updatedAt": "2024-03-14T12:00:00Z"
}
}
Delete Campaign
Parameters
Response
{
"message": "Campaign deleted successfully",
"campaignId": "campaign123"
}
Campaign Filters
List Filters
Parameters
Response
{
"filters": [
{
"id": "filter123",
"name": "High Engagement US",
"criteria": {
"region": "US",
"minEngagementRate": 0.05
},
"createdAt": "2024-03-14T12:00:00Z"
}
]
}
Get Filter
GET /campaign-filters/:id
Get a specific campaign filter
Parameters
Response
{
"id": "filter123",
"name": "High Engagement US",
"criteria": {
"region": "US",
"minEngagementRate": 0.05,
"categories": ["fashion", "beauty"],
"minFollowers": 10000
},
"createdAt": "2024-03-14T12:00:00Z",
"updatedAt": "2024-03-14T12:00:00Z"
}
Create Filter
Create a new campaign filter
Parameters
Request Body
{
"name": "High Engagement US",
"criteria": {
"region": "US",
"minEngagementRate": 0.05,
"categories": ["fashion", "beauty"],
"minFollowers": 10000
}
}
Response
{
"id": "filter123",
"name": "High Engagement US",
"criteria": {
"region": "US",
"minEngagementRate": 0.05,
"categories": ["fashion", "beauty"],
"minFollowers": 10000
},
"createdAt": "2024-03-14T12:00:00Z"
}
Update Filter
PUT /campaign-filters/:id
Update an existing campaign filter
Parameters
Request Body
{
"name": "Updated High Engagement US",
"criteria": {
"minEngagementRate": 0.06
}
}
Response
{
"message": "Filter updated successfully",
"filter": {
"id": "filter123",
"name": "Updated High Engagement US",
"criteria": {
"region": "US",
"minEngagementRate": 0.06,
"categories": ["fashion", "beauty"],
"minFollowers": 10000
},
"updatedAt": "2024-03-14T12:00:00Z"
}
}
Delete Filter
DELETE /campaign-filters/:id
Delete a campaign filter
Parameters
Response
{
"message": "Filter deleted successfully",
"filterId": "filter123"
}