Skip to main content

Campaigns

List Campaigns

GET /campaigns
Get all campaigns

Parameters

userId
string
required
The ID of the user

Response

campaigns
array
List of campaigns
{
  "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

GET /campaigns/:id
Get a specific campaign

Parameters

id
string
required
Campaign ID
userId
string
required
The ID of the user

Response

campaign
object
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

POST /campaigns
Create a new campaign

Parameters

userId
string
required
The ID of the user

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

campaign
object
Created campaign details
{
  "id": "campaign123",
  "name": "Summer Collection",
  "status": "draft",
  "createdAt": "2024-03-14T12:00:00Z"
}

Update Campaign

PUT /campaigns/:id
Update an existing campaign

Parameters

id
string
required
Campaign ID
userId
string
required
The ID of the user

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

DELETE /campaigns/:id
Delete a campaign

Parameters

id
string
required
Campaign ID
userId
string
required
The ID of the user

Response

{
  "message": "Campaign deleted successfully",
  "campaignId": "campaign123"
}

Campaign Filters

List Filters

GET /campaign-filters
Get all campaign filters

Parameters

userId
string
required
The ID of the user

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

id
string
required
Filter ID
userId
string
required
The ID of the user

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

POST /campaign-filters
Create a new campaign filter

Parameters

userId
string
required
The ID of the user

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

id
string
required
Filter ID
userId
string
required
The ID of the user

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

id
string
required
Filter ID
userId
string
required
The ID of the user

Response

{
  "message": "Filter deleted successfully",
  "filterId": "filter123"
}