Campaigns

A campaign's headline metrics since `since`

Returns the campaign's headline email metrics. The total* counters accumulate from since (default: 12 months ago). totalOpened and totalClicked count distinct contacts, not events; totalOpened covers only emails sent while the campaign's open tracking was on, so it is 0 when tracking is off. Only the token owner's own campaigns resolve: a campaign delegated to you, one shared by your team's visibility settings, and a deleted one all answer 404. Rate limit: 30 requests/minute and 1,000/day per token owner, shared by every campaign, scheduled-send, campaign-template and knowledge-hub endpoint.

Errors:

  • 404 CAMPAIGN_NOT_FOUND — No campaign with this id exists, it belongs to another account (including a campaign delegated to you or shared by your team's visibility settings), or it has been deleted.
  • 422 VALIDATION_FAILED — since is not an ISO 8601 date-time, or campaignId is not a 24-character hex id.
  • 429 RATE_LIMITED — More than 30 campaign requests in a minute, or 1,000 in a day, for this token owner (the bucket is shared by every /business/campaigns, /business/scheduled-sends, /business/campaign-templates and /business/knowledge-hubs call).
  • 500 UNEXPECTED_ERROR — An unhandled failure; the detail stays in our logs and is never returned.

Requires one of the following token scopes: campaigns.

get/business/campaigns/{campaignId}/stats

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/stats
  • Auth: HTTP basic

Path parameters

campaignIdstring required

The campaign's id (24-character hex ObjectId), as returned by POST /business/campaigns or as the campaignId of a GET /business/campaigns row.

Query parameters

sincestring

ISO 8601 date-time from which the total* counters are accumulated (default: 12 months ago).

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.