Get attribution metrics for one or more Brevo campaigns or workflows

api-keystring

The API key should be passed in the request headers as api-key for authentication.

periodFromdatetimeOptional

When getting metrics for a specific period, define the starting datetime in RFC3339 format

periodTodatetimeOptional

When getting metrics for a specific period, define the end datetime in RFC3339 format

emailCampaignId[]list of stringsOptional

The email campaign ID(s) to get metrics for

smsCampaignId[]list of stringsOptional

The SMS campaign ID(s) to get metrics for

automationWorkflowEmailId[]list of stringsOptional

The automation workflow ID(s) to get email attribution metrics for

automationWorkflowSmsId[]list of stringsOptional

The automation workflow ID(s) to get SMS attribution metrics for

resultslist of objects

List of conversion attribution metrics

totalsobject

Attribution list aggregated totals

400

Bad Request Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows({});
8	}
9	main();

1	{
2	"results": [
3	{
4	"averageBasket": 3,
5	"conversionSource": "email_campaign",
6	"id": 1.1,
7	"ordersCount": 300,
8	"revenue": 900
9	},
10	{
11	"averageBasket": 4,
12	"conversionSource": "email_campaign",
13	"id": 1.1,
14	"ordersCount": 200,
15	"revenue": 800
16	}
17	],
18	"totals": {
19	"averageBasket": 3.4,
20	"ordersCount": 500,
21	"revenue": 1700
22	}
23	}