cervinodata-api-client

CervinodataApiClient - JavaScript client for cervinodata-api-client

Before you get going with the Cervinodata API, set up Cervinodata (read the support page here: How to set up the Cervinodata API).

To use the Cervinodata API, you need all of the following:

1. An active Cervinodata account, you can start a free trial here
2. At least one connection to a platform (check here)
3. At least one account switched ON (check here)
4. At least one data refresh executed (check here)
5. An active API token (check here)

Note that limits apply for Free plan users.

If you wish to automate your Cervinodata API connection, check out the list of client API's at https://github.com/Cervinodata.

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

• API version: 1.0.0
• Package version: 0.1.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cervinodata-api-client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your cervinodata-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/cervinodata/javascript then install it via:

    npm install cervinodata/javascript --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CervinodataApiClient = require('cervinodata-api-client');

var defaultClient = CervinodataApiClient.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new CervinodataApiClient.AdvertisingDataApi()
var organisationUuids = ["null"]; // {[String]} Organisation uuids
var opts = {
  'fromDate': new Date("2013-10-20"), // {Date} From date
  'dateFormat': "dateFormat_example", // {String} Outputted date format
  'format': "format_example" // {String} Output format (use csv for large result sets)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAdAccountReportPerOrganisationPerDay(organisationUuids, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://app.cervinodata.com/api/v1

Class	Method	HTTP request	Description
CervinodataApiClient.AdvertisingDataApi	getAdAccountReportPerOrganisationPerDay	GET /data/ad-account-report-per-organisation-per-day/{organisationUuids}	Return ad account report per organisation per day
CervinodataApiClient.AdvertisingDataApi	getAdAccounts	GET /data/ad-accounts/{organisationUuid}	Return ad accounts by organisation
CervinodataApiClient.AdvertisingDataApi	getAdCampaignReportPerDay	GET /data/ad-campaign-report-per-day/{organisationUuid}	Return ad campaign report per day by organisation
CervinodataApiClient.AdvertisingDataApi	getAdCampaignReportPerOrganisationPerAccountPerCampaignPerDevicePerDay	GET /data/ad-campaign-report-per-organisation-per-account-per-campaign-per-device-per-day/{organisationUuids}	Return ad campaign report per organisation per account per campaign per device per day
CervinodataApiClient.AdvertisingDataApi	getAdCampaignReportPerOrganisationPerAccountPerDay	GET /data/ad-campaign-report-per-organisation-per-account-per-day/{organisationUuids}	Return ad campaign report per organisation per account per day
CervinodataApiClient.AdvertisingDataApi	getAdCampaigns	GET /data/ad-campaigns/{organisationUuid}	Return ad campaigns by organisation
CervinodataApiClient.AdvertisingDataApi	getAdGroups	GET /data/ad-groups/{organisationUuid}	Return ad groups by organisation
CervinodataApiClient.AdvertisingDataApi	getAdformExtendedReportPerOrganisationPerAccountPerCampaignPerCreativePerDay	GET /data/adform-extended-report-per-organisation-per-account-per-campaign-per-creative-per-day/{organisationUuids}	Return adform extended report per organisation per account per campaign per creative per day
CervinodataApiClient.AdvertisingDataApi	getAdformExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/adform-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return adform extended report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getAdformExtendedReportPerOrganisationPerAccountPerCampaignPerLineItemPerDay	GET /data/adform-extended-report-per-organisation-per-account-per-campaign-per-line-item-per-day/{organisationUuids}	Return adform extended report per organisation per account per campaign per line item per day
CervinodataApiClient.AdvertisingDataApi	getBingAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/bing-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return bing ads extended report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getFacebookAdCustomConversionReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/facebook-ad-custom-conversion-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return facebook ad custom conversion report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerAdGroupPerDay	GET /data/facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-ad-group-per-day/{organisationUuids}	Return facebook ad extended report per organisation per account per campaign per ad group per day
CervinodataApiClient.AdvertisingDataApi	getFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerAdGroupPerDayPlus	GET /data/facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-ad-group-per-day-plus/{organisationUuids}	Return facebook ad extended report per organisation per account per campaign per ad group per day plus
CervinodataApiClient.AdvertisingDataApi	getFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerAdPerDay	GET /data/facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-ad-per-day/{organisationUuids}	Return facebook ad extended report per organisation per account per campaign per ad per day
CervinodataApiClient.AdvertisingDataApi	getFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return facebook ad extended report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerDayPlus	GET /data/facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-day-plus/{organisationUuids}	Return facebook ad extended report per organisation per account per campaign per day plus
CervinodataApiClient.AdvertisingDataApi	getFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerDevicePerDay	GET /data/facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-device-per-day/{organisationUuids}	Return facebook ad extended report per organisation per account per campaign per device per day
CervinodataApiClient.AdvertisingDataApi	getGoogleAdsReportPerOrganisationPerAccountPerCampaignPerDevicePerDay	GET /data/google-ads-report-per-organisation-per-account-per-campaign-per-device-per-day/{organisationUuids}	Return google ads report per organisation per account per campaign per device per day
CervinodataApiClient.AdvertisingDataApi	getHashedAdCampaignReportPerOrganisationPerAccountPerDay	GET /data/hashed-ad-campaign-report-per-organisation-per-account-per-day/{organisationUuids}	Return hashed ad campaign report per organisation per account per day
CervinodataApiClient.AdvertisingDataApi	getLinkedInAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/linkedin-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return linkedin ads extended report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getPinterestAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/pinterest-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return pinterest ads extended report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getSnapchatAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/snapchat-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return snapchat ads extended report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getTikTokAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/tiktok-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return tiktok ads extended report per organisation per account per campaign per day
CervinodataApiClient.AdvertisingDataApi	getTwitterAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/twitter-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return twitter ads extended report per organisation per account per campaign per day
CervinodataApiClient.AnalyticsDataApi	getGA4ReportPerChannelGroupPerOrganisationPerProperty	GET /data/ga4-report-per-channel-group-per-organisation-per-property/{organisationUuids}	Return GA4 report per channel group per organisation per property
CervinodataApiClient.AnalyticsDataApi	getGA4ReportPerChannelGroupPerOrganisationPerPropertyPerMonth	GET /data/ga4-report-per-channel-group-per-organisation-per-property-per-month/{organisationUuids}	Return GA4 report per channel group per organisation per property per month
CervinodataApiClient.AnalyticsDataApi	getGA4ReportPerChannelGroupPerProductNamePerOrganisationPerPropertyPerMonth	GET /data/ga4-report-per-channel-group-per-product-name-per-organisation-per-property-per-month/{organisationUuids}	Return GA4 report per channel group per product name per organisation per property per month
CervinodataApiClient.AnalyticsDataApi	getGA4ReportPerChannelGroupPerSourceMediumPerOrganisationPerPropertyPerMonth	GET /data/ga4-report-per-channel-group-per-source-medium-per-organisation-per-property-per-month/{organisationUuids}	Return GA4 report per channel group per source medium per organisation per property per month
CervinodataApiClient.AnalyticsDataApi	getViews	GET /data/views/{organisationUuid}	Return views by organisation
CervinodataApiClient.AnalyticsDataDefaultMetricsApi	getAnalyticsReportPerCampaignPerDay	GET /data/analytics-report-per-campaign-per-day/{organisationUuid}	Return analytics report per campaign per day by organisation
CervinodataApiClient.AnalyticsDataDefaultMetricsApi	getAnalyticsReportPerChannelGroupPerDay	GET /data/analytics-report-per-channel-group-per-day/{organisationUuid}	Return analytics report per channel group per day by organisation
CervinodataApiClient.AnalyticsDataDefaultMetricsApi	getAnalyticsReportPerDevicePerChannelGroupPerOrganisationPerViewPerDay	GET /data/analytics-report-per-device-per-channel-group-per-organisation-per-view-per-day/{organisationUuids}	Return analytics report per device per channel group per organisation per view per day
CervinodataApiClient.AnalyticsDataDefaultMetricsApi	getAnalyticsReportPerDevicePerDay	GET /data/analytics-report-per-device-per-day/{organisationUuid}	Return analytics report per device per day by organisation
CervinodataApiClient.AnalyticsDataDefaultMetricsApi	getAnalyticsReportPerSourceMediumPerDay	GET /data/analytics-report-per-source-medium-per-day/{organisationUuid}	Return analytics report per source medium per day by organisation
CervinodataApiClient.AnalyticsDataDefaultMetricsApi	getGA4ReportPerDevicePerChannelGroupPerOrganisationPerPropertyPerDay	GET /data/ga4-report-per-device-per-channel-group-per-organisation-per-property-per-day/{organisationUuids}	Return GA4 report per device per channel group per organisation per property per day
CervinodataApiClient.AnalyticsDataGoalsApi	getAnalyticsGoalReportPerCampaignPerDay	GET /data/analytics-goal-report-per-campaign-per-day/{organisationUuid}	Return analytics goal report per campaign per day by organisation
CervinodataApiClient.AnalyticsDataGoalsApi	getAnalyticsGoalReportPerChannelGroupPerDay	GET /data/analytics-goal-report-per-channel-group-per-day/{organisationUuid}	Return analytics goal report per channel group per day by organisation
CervinodataApiClient.AnalyticsDataGoalsApi	getAnalyticsGoalReportPerDevicePerDay	GET /data/analytics-goal-report-per-device-per-day/{organisationUuid}	Return analytics goal report per device per day by organisation
CervinodataApiClient.AnalyticsDataGoalsApi	getAnalyticsGoalReportPerSourceMediumPerDay	GET /data/analytics-goal-report-per-source-medium-per-day/{organisationUuid}	Return analytics goal report per source medium per day by organisation
CervinodataApiClient.AnalyticsDataProductMetricsApi	getGA4ReportPerProductNamePerOrganisationPerPropertyPerWeek	GET /data/ga4-report-per-product-name-per-organisation-per-property-per-week/{organisationUuids}	Return GA4 report per product name per organisation per property per week
CervinodataApiClient.AnalyticsDataProductMetricsApi	getGA4ReportPerProductSkuPerOrganisationPerPropertyPerWeek	GET /data/ga4-report-per-product-sku-per-organisation-per-property-per-week/{organisationUuids}	Return GA4 report per product sku per organisation per property per week
CervinodataApiClient.AnalyticsDataTransactionMetricsApi	getGA4ReportPerCampaignPerOrganisationPerProperty	GET /data/ga4-report-per-campaign-per-organisation-per-property/{organisationUuids}	Return GA4 report per campaign per organisation per property
CervinodataApiClient.AnalyticsDataTransactionMetricsApi	getGA4ReportPerCampaignPerOrganisationPerPropertyPerMonth	GET /data/ga4-report-per-campaign-per-organisation-per-property-per-month/{organisationUuids}	Return GA4 report per campaign per organisation per property per month
CervinodataApiClient.CampaignGroupApi	getCampaignGroupAdReportPerOrganisationPerCampaignPerDay	GET /data/campaign-group-ad-report-per-organisation-per-campaign-per-day/{organisationUuids}	Return campaign group ad report per organisation per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupAdReportPerOrganisationPerCampaignPerWeek	GET /data/campaign-group-ad-report-per-organisation-per-campaign-per-week/{organisationUuids}	Return campaign group ad report per organisation per campaign per week
CervinodataApiClient.CampaignGroupApi	getCampaignGroupAdReportPerOrganisationPerDay	GET /data/campaign-group-ad-report-per-organisation-per-day/{organisationUuids}	Return campaign group ad report per organisation per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupAdformExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-adform-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group adform extended report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupAdformReportPerOrganisationPerCampaignPerDay	GET /data/campaign-group-adform-report-per-organisation-per-campaign-per-day/{organisationUuids}	Return campaign group adform report per organisation per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupAdformReportPerOrganisationPerCampaignPerLineItemPerDay	GET /data/campaign-group-adform-report-per-organisation-per-campaign-per-line-item-per-day/{organisationUuids}	Return campaign group adform report per organisation per campaign per line-item per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupAnalyticsReportPerOrganisationPerDay	GET /data/campaign-group-analytics-report-per-organisation-per-day/{organisationUuids}	Return campaign group analytics report per organisation per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupBingAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-bing-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group bing ads extended report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupDoubleClickBidManagerReportPerOrganisationPerAccountPerCampaignPerCreativePerDay	GET /data/campaign-group-doubleclick-bid-manager-report-per-organisation-per-account-per-campaign-per-creative-per-day/{organisationUuids}	Return campaign group doubleclick bid manager report per organisation per account per campaign per creative per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupDoubleClickBidManagerReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-doubleclick-bid-manager-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group doubleclick bid manager report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupDoubleClickCampaignManagerReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-doubleclick-campaign-manager-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group doubleclick campaign manager report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupFacebookAdCustomConversionReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-facebook-ad-custom-conversion-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group facebook ad custom conversion report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerAdGroupPerDay	GET /data/campaign-group-facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-ad-group-per-day/{organisationUuids}	Return campaign group facebook ad extended report per organisation per account per campaign per ad group per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupFacebookAdExtendedReportPerOrganisationPerAccountPerCampaignPerAdPerDay	GET /data/campaign-group-facebook-ad-extended-report-per-organisation-per-account-per-campaign-per-ad-per-day/{organisationUuids}	Return campaign group facebook ad extended report per organisation per account per campaign per ad per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupFacebookAdExtendedReportPerOrganisationPerCampaignPerDay	GET /data/campaign-group-facebook-ad-extended-report-per-organisation-per-campaign-per-day/{organisationUuids}	Return campaign group facebook ad extended report per organisation per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupFacebookAdReportPerOrganisationPerCampaignPerDay	GET /data/campaign-group-facebook-ad-report-per-organisation-per-campaign-per-day/{organisationUuids}	Return campaign group facebook ad report per organisation per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupGoalReportPerOrganisationPerDay	GET /data/campaign-group-goal-report-per-organisation-per-day/{organisationUuids}	Return campaign group goal report per organisation per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupGoogleAdsExtendedReportPerOrganisationPerAccountPerCampaignPerAdGroupPerDay	GET /data/campaign-group-google-ads-extended-report-per-organisation-per-account-per-campaign-per-ad-group-per-day/{organisationUuids}	Return campaign group google ads extended report per organisation per account per campaign per ad group per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupGoogleAdsReportPerOrganisationPerCampaignPerDay	GET /data/campaign-group-google-ads-report-per-organisation-per-campaign-per-day/{organisationUuids}	Return campaign group google ads report per organisation per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupLinkedInAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-linkedin-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group linkedin ads extended report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupPinterestAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-pinterest-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group pinterest ads extended report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupReportPerOrganisationPerDay	GET /data/campaign-group-report-per-organisation-per-day/{organisationUuids}	Return campaign group report per organisation per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupSnapchatAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-snapchat-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group snapchat ads extended report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupTikTokAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-tiktok-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group tiktok ads extended report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupTwitterAdsExtendedReportPerOrganisationPerAccountPerCampaignPerDay	GET /data/campaign-group-twitter-ads-extended-report-per-organisation-per-account-per-campaign-per-day/{organisationUuids}	Return campaign group twitter ads extended report per organisation per account per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupVideoReportPerOrganisationPerCampaignPerDay	GET /data/campaign-group-video-report-per-organisation-per-campaign-per-day/{organisationUuids}	Return campaign group video report per organisation per campaign per day
CervinodataApiClient.CampaignGroupApi	getCampaignGroupVideoReportPerOrganisationPerDay	GET /data/campaign-group-video-report-per-organisation-per-day/{organisationUuids}	Return campaign group video report per organisation per day
CervinodataApiClient.GenericDataApi	getCampaignGroups	GET /data/campaign-groups	Return campaign groups
CervinodataApiClient.GenericDataApi	getOrganisations	GET /data/organisations	Return organisations
CervinodataApiClient.ProductDataApi	getGA4ReportPerChannelGroupPerProductNamePerOrganisationPerPropertyPerMonth	GET /data/ga4-report-per-channel-group-per-product-name-per-organisation-per-property-per-month/{organisationUuids}	Return GA4 report per channel group per product name per organisation per property per month

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication