A | B | C | D | E | F | |
---|---|---|---|---|---|---|
1 | ActiveCampaign Resources | |||||
2 | ||||||
3 | This document describes each of the resources available in the Looker data connector for ActiveCampaign by Find My Insight. It lists all of the resources currently available with descriptions of fields and recommend fields that can you used as join keys for blending with other resources. | |||||
4 | ||||||
5 | This document is Updated regularly so please check back. | Last Updated | Thursday, August 24, 2023 | |||
6 | ||||||
7 | Category | Resource Name | Has Totals Check Box | Parameters | Resource Description | |
8 | Account | Accounts | Yes | List of all Accounts (organisations) in your ActiveCampaign subscription. Recommended join key "id" (Account Id) | ||
9 | Account Custom Field Values | Yes | Resource storing all custom account (organisations) from your ActiveCampaign subscription. Recommended Join key "accountid" | |||
10 | Account Custom Fields | Yes | Resource for storing meta data associated with your Account (organisation) custom fields. Recommended join key "id" | |||
11 | Associations | Yes | List of Contacts associated with Accounts (Organisations). Includes contact id and job descriptions- Recommended Join keys "account" (Account id) and "contact" (Contact id) | |||
12 | ||||||
13 | Admin | Addresses | Yes | Resource for storing all of the addresses you create within your ActiveCampaign subscription settings. | ||
14 | Brandings | Yes | Resource with all the metadata associated with branding and customisation of your ActiveCampaign subscription | |||
15 | Calendars | Yes | All calendars associated with your ActiveCampaign subscription | |||
16 | Connections | Yes | This resource lists all of the services that you have integrated with your ActiveCampaign subscription. This is particularly useful for Ecomm. Recommend Join key "id" (Connection id). | |||
17 | Forms | Yes | Resource with all of the meta data associated with the form your users can create in your ActiveCampaign subscription | |||
18 | Responses | Yes | Resource listing of all your saved responses in your ActiveCampaign subscription. | |||
19 | Tracked Events | Yes | Resource with list of all the events that are tracked within your ActiveCampaign Subscription | |||
20 | White Listed Site Tracking Domains | Yes | Resource with list of all white listed domains for your ActiveCampaign subscription | |||
21 | Users | Yes | Resource listing all of the users currently set up inside of your ActiveCampaign subscription. | |||
22 | Groups | Yes | Resource with all of the permissions for each group that you create for your users in your ActiveCampaign subscription | |||
23 | Webhook events | Yes | Resource listing all of the webhook events associated with your ActiveCampaign subscription | |||
24 | Webhooks | Yes | Resource listing of all the endpoints that have been fired with your ActiveCampaign subscription | |||
25 | ||||||
26 | Automations | Automations | Yes | Summary of all automations in your ActiveCampaign subscription. Recommended join key "id" (automation id) | ||
27 | Automation Campaigns | No | This resource provides all of the summary statistics and meta data associated with Campaigns (Broadcasts) associated with a particular Automation. The fields are the same as those of Campaigns | |||
28 | Contact Automations | Yes | Resource capturing each contact and summary statistics for when they enter into an automation. Recommended Join keys include "contact" (Contact id), automation (Automation id) | |||
29 | ||||||
30 | Campaigns | Campaigns | Yes | This resource provides all of the summary statistics and meta data associated with Campaigns (Broadcasts). This includes those occur as part of an automation). Recommended Join Keys "id" (campaign id), "automation" (automation id) | ||
31 | Links for All Campaign | Yes | Resource with summary metrics for all Campaigns. Recommended Join key "campaign id" and "message id" | |||
32 | Links of One Campaign | No | Resource with metrics for a single Campaign. This end point requires you to enter a single Campaign Id as a parameter. Recommended Join key "campaign id" and "message id" | |||
33 | Campaign Messages | Yes | Resource with all of the campaign messages in your ActiveCampaign subscription. Possible join keys are campaignid and messageid. | |||
34 | Campaign Lists | Yes | Resource with all of the campaign lists in your ActiveCampaign subscription. Possible join keys are campaignid and listid. | |||
35 | Messages | Yes | Resource with all of the messages and the content in your ActiveCampaign subscription. (This includes versioning). Possible join key is Name. However you would need to get the correct ed_Version to avoid duplicate rows in your blend | |||
36 | Campaign Report Open List ** | No | Resource listing of all the contacts on certain campaign. IMPORTANT: this is API v1, an old version. ActiveCampaign has no plan to sunset it at this time and if they ever do, they will provide plenty of advance notice. | |||
37 | ||||||
38 | Contacts | Contacts | Yes | Full table of all contacts in your ActiveCampaign Subscription. Includes summary statistics about your contacts. Recommended join keys "id" (contact id) and "orgid" (organisation or account id) . This end point also have parameters that allow you to filter the result by the following. contact id, email address (containing any given string), form id, contact id (greater than any value you have entered), contact id (less than any value you have entered), names, Segment id, automation id, status, tag id, wait id, creation date, updated date. You can only enter one value for each parameter, however you can enter more than one parameter type. The contact end point is the cornerstone of many great insights. If you have a large contact database it is important to use parameters to limit the size of your API call. This also improves performance and speed of your dashboards in ActiveCampaign. | ||
39 | Contact Custom Fields | Yes | Resource listing all of your custom contact fields and associated meta data. Recemmended Join key "id" (Custom field id) | |||
40 | Contact Custom Field Options | Yes | Resource which captures all the meta data in relation to custom contact fields that are of the type "dropdown, checkbox, listbox, radio" it lists all the options of the custom field. You are required to submit a custom field id as a parameter for this to work. Recommended join key "field" (field id) | |||
41 | Contact Custom Field Values | Yes | Resource capturing all the values of your contact custom fields. This is an excellent end point to blend with your contacts end point. It can created excellent dashboards for segmentation insight. Recommended Join keys include contact (cContact id) | |||
42 | Contact Lists | Yes | Resource listing all the lists of all contacts or one contact in your ActiveCampaign subscription | |||
43 | Contact Tags | Yes | Contact ID (digits ONLY), Offset (digits ONLY, min 0), Max Amount of Data (digits ONLY, min 1, max 30000) | Resource listing all the tags of all contacts or one contact in your ActiveCampaign subscription | ||
44 | Lists | Yes | Resource containing all of the meta data and rules created for each of your ActiveCampaign contact lists. | |||
45 | Scores | Yes | Resource listing all scores as created in your ActiveCampaign Subscription | |||
46 | Score Values | Yes | Resource listing all score values as created in your ActiveCampaign Subscription | |||
47 | Segments | Yes | Resource listing all of the segments that have been created in your ActiveCampaign subscription. Segments are used to created more targeted groups for sending campaigns to. | |||
48 | Tags | Resource summarising the performance of all the tags in your ActiveCampaign subscription | ||||
49 | ||||||
50 | Deals | Deals | Yes | Resource of your deals and deal metrics summarised. You can use a parameter to limited to number of deals returned. The parameters include title, contact, and org. Recommended join keys include "contact" (contact id), "account" (Account id), | ||
51 | Pipelines | Yes | Resource detailing all of the stages that make up the sales pipelines you have created inside of you ActiveCampaign subscription. Recommended join keys include "id" (Pipeline id) and "stages" (Stage id) | |||
52 | Stages | Yes | This resource lists all of the deal stages you have created in your ActiveCampaign Subscription. Recommended join key "id" (Stage id) | |||
53 | Deal Custom Fields | Yes | This resource lists all of the deal custom fields you have created for your ActiveCampaign subscription. Recommended join key "id" (Custom field id) | |||
54 | Deal Custom Field Values | Yes | This resource contains all of the values as entered into the deal custom fields on each deal. Recommended join key "dealid" (Deal id) and "customfieldid" (Custom field id) | |||
55 | Secondary Contact, aka contact deals | Yes | This resource lists any secondary contacts associated with a deal. Recommended join keys "deal" (Deal id) and "contact" (Contact id) | |||
56 | Tasks | Yes | This resource captures the details of all the tasks created inside of your ActiveCampaign subscription. Tasks can be be either deal or contact related. Recommended join keys include "relid" This can be either contact id or deal id. This end point also utilises parameters which can be useful for blending. Selectable parameters include Title (partial or full string search), Relationship (contact or deal), Contact id, Deal Id, Status, Note (use a string search), Task Type Id (type of task), User id, Assigned user Id. This is a great way to segment your data. | |||
57 | Task Types | Yes | Resource listing all of the tasks used in deals. | |||
58 | ||||||
59 | Ecomm | ecomCustomers | Yes | Resource that allows you to bring customer summary sales and order information from your ecomm system. Recommended join key "email" | ||
60 | ecomOrders | Yes | Resource that contains all of the orders created in your external ecomm site. Recommended Join key "email" | |||
61 | ecomOrderProducts | Yes | Resource containing all of your order product information in your external ecomm system. Recommended join key "ecomOrder" | |||
62 | ||||||
63 | ||||||
64 |