Authorization
All requests must include a Bearer token in theAuthorization header. You can find your API key in the Leadterra dashboard under Settings → API Keys.
Path Parameters
The unique ID of the campaign whose metrics you want to retrieve. You receive this ID when you create a campaign. Example:
camp_123.Request Body
This endpoint accepts no request body.Example Request
Response Fields
The ID of the campaign these metrics belong to.
Total number of leads enrolled in the campaign, regardless of their current send state.
Number of emails that have been submitted for delivery. Includes emails regardless of delivery outcome.
Number of emails confirmed as accepted by the recipient’s mail server. Does not imply the email reached the inbox.
Number of emails that resulted in a hard or soft bounce. Leads that trigger a hard bounce are automatically suppressed from future sends.
Number of leads who have sent at least one reply to any step in the sequence. Leads with a reply are automatically removed from further sequence steps.
Number of emails currently waiting in the send queue. A non-zero value while the campaign is
paused indicates held messages that will resume on restart.Ratio of unique opens to delivered emails, expressed as a decimal between
0 and 1. For example, 0.42 represents a 42 % open rate.Ratio of replied leads to delivered emails, expressed as a decimal between
0 and 1. For example, 0.08 represents an 8 % reply rate.Example Response
Error Codes
| HTTP Status | Code | Meaning |
|---|---|---|
400 Bad Request | invalid_request | The request was malformed or contained unexpected parameters. |
401 Unauthorized | authentication_failed | The Authorization header is missing, malformed, or the key is invalid. |
404 Not Found | campaign_not_found | No campaign with the given id exists in your workspace. |