Statistics

This section shows the available routes related to AcyMailing statistics

Get global statistics

GET https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=getCampaignStatistics

Get campaign statistics by campaign ID

Query Parameters

Name
Type
Description

campaignId*

Int

The ID of the campaign

Headers

Name
Type
Description

Api-Key*

String

The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License".

Get detailed statistics

GET https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=getCampaignStatisticsDetailed

This route returns a listing of each user statistics for a specific campaign.

Query Parameters

Name
Type
Description

campaignId*

Int

ID of the campaign

offset

Int

From which element in the database you would like to start getting campaign, by default it's set to 0

limit

Int

The number of campaigns you would like to get in your request, by default it's set to 100

Headers

Name
Type
Description

Api-key*

String

The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License".

Get click statistics per user

GET https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=getCampaignStatisticsClicks

This route returns a listing of all the users who have click statistics

Query Parameters

Name
Type
Description

campaignId*

Int

ID of the campaign

Headers

Name
Type
Description

Api-Key*

String

The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License".

Get click statistics per URL

GET https://www.example.com/index.php?page=acymailing_front&option=com_acym&ctrl=api&task=getCampaignStatisticsLinks

This route returns a listing of links statistics for a specific campaign.

Query Parameters

Name
Type
Description

campaignId*

Int

ID of the campaign

Headers

Name
Type
Description

Api-Key*

String

The API key of a valid AcyMailing license used in the AcyMailing configuration page, tab "License".

Last updated