Active Campaign walkthrough

Integrate data from Active Campaign into Data Integration to extract, configure, and manage your campaign data for reporting and analysis.

Prerequisites

Create an Active Campaigns connection.

Pulling data from Active Campaigns

Step 1: selecting the Active Campaign connection

• Choose the appropriate Active Campaign connection from the available list.
• If the desired connection does not exist, create or update an existing connection.

Step 2: choosing reports

Choose a report from the Report drop-down menu.

Report details

Access the API using a base URL specific to your account. Find your API URL on the My Settings page under the Developer tab. The URL paths begin with /api/3 to specify version 3 of the API. The full URL is in the format:

https://<your-account>.api-us1.com/api/3/<resource>

All API calls must use HTTPS.

Report	Endpoint	Query Parameters
contacts	https://<your-account>.api-us1.com/api/3/contacts	status & DateTime filters
contactLists	https://<your-account>.api-us1.com/api/3/contacts	status & DateTime filters, retrieves contactList Data with parameter "include": "contactLists
contactTags	https://<your-account>.api-us1.com/api/3/contacts	status & DateTime filters, retrieves contactList Data with parameter "include": "contactTags
lists	https://<your-account>.api-us1.com/api/3/lists
tags	https://<your-account>.api-us1.com/api/3/tags
campaigns	https://<your-account>.api-us1.com/api/3/campaigns
campaignMessages	https://<your-account>.api-us1.com/api/3/campaignMessages
messages	https://<your-account>.api-us1.com/api/3/messages

For more information about the Active Campaigns API, refer to the source topic.

Step 3: choosing Report time period

Filter some reports by date:

• Select the extract method to filter the report for specific periods or dates.

• Choose from options list- Created, Updated.

• Select the report time period.

All the reports support two kinds of time periods

• Date Range
  • Pulls data in the date range between the provided start and end dates, including the end date.
  • You must select a start date.
  • Leaving the end date empty pulls data up to the current river run time.
  • Select a timezone offset to send dates based on the offset.
  • Use Last Days Back For Each Run to include data from a set number of days before the start date.
• Predefined date - A date range defined by Data Integration:
  • Day: Yesterday.
  • Week (From Monday to Sunday): Week to date, Previous week, Previous week to date.
  • Month: Month to date, Previous month, Previous month to date.
  • Year: Year to date.

Step 4: optimizing data pull using interval chunks

Data Integration can run over the increment using chunks, to make the loading efficient and precise, for large data.

Choose from:

• Don't Split: Pulls data from start to end date in one bulk.
• Daily: Splits the run into daily chunks from the start to the end date.
• Monthly: Splits the run into monthly chunks from the start to the end date.
• Yearly (Less/not Recommended): Splits the run into yearly chunks from the start to the end.

Interval size: Set the size of each interval. For example, setting the Interval Size to 4 with a Daily Interval Chunk splits the date period into 4-day intervals. The period from January 1, 2020, to January 8, 2020, is divided into two intervals: from January 1, 2020, to April 1, 2020, and from May 1, 2020, to January 8, 2020.

API Rate Limits

You can make up to 5 requests per second per access token.