API Data Provider - Online Help

ActiveCampaign Profile for API Driver

The CData API Profile for ActiveCampaign allows you to query data from ActiveCampaign. The ActiveCampaign profile is a single file (i.e. activecampaign.apip) which can be used along with the CData API Driver. The profile contains the table definitions and other metadata that the CData API Driver uses to connect to ActiveCampaign.

To use the ActiveCampaign Profile, set the Profile property of CData API Driver to the path of the ActiveCampaign profile. In addition, other connection properties will be required to authenticate to the service. You can find instructions specific to the ActiveCampaign Profile in Connecting to ActiveCampaign. Once the connction to the profile has been established, you may access the data exposed by the profile from code or from various applications.

Using the Profile

The API Profile can be used to connect to data exposed by a service in various applications. See Using the API Profile for a list of guides on using the drivers in different frameworks, such as ADO.NET, JDBC or using different applications by connecting to the ODBC, Excel Add-in, or SSIS provider.

SQL Compliance

The API Profile are fully compatible with SQL-92 syntax for selecting and executing procedures. In SQL Compliance, you can find a syntax reference and code examples outlining the supported SQL of each profile.

Schema Discovery

The API Profiles support standard schema collections to retrieve the metadata exposed. See Schema Discovery to find more about the standard schema classes in ADO.NET and JDBC exposing this data. Additionally, you may query the System Tables to access additional metadata, such as data source capabilities.

Tables

The provider models the data in APIs into a list of tables that can be queried using standard SQL statements. In the Tables section you can find descriptions of the available table in the profile, including column names and datatypes.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to access functionality not represented as SELECT, INSERT, UPDATE, or DELETE. Stored Procedures describes the available procedures in the profile, along with the necessary parameters.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7593.0