Skip to content
The Cervinodata Java API Client allows you to retrieve data of multiple platforms with just one API connection.
Java Other
  1. Java 99.1%
  2. Other 0.9%
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
.openapi-generator
docs
gradle/wrapper
src
.gitignore
.openapi-generator-ignore
.travis.yml
README.md
build.gradle
build.sbt
git_push.sh
gradle.properties
gradlew
gradlew.bat
pom.xml
settings.gradle

README.md

cervinodata-java-client

Cervinodata API documentation

  • API version: 1.0.0
    • Build date: 2020-02-18T14:21:25.237Z[GMT]

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)

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

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.cervinodata</groupId>
  <artifactId>cervinodata-java-client</artifactId>
  <version>0.1.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.cervinodata:cervinodata-java-client:0.1.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/cervinodata-java-client-0.1.0.jar
  • target/lib/*.jar

Getting Started

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

// Import classes:
import com.cervinodata.client.ApiClient;
import com.cervinodata.client.ApiException;
import com.cervinodata.client.Configuration;
import com.cervinodata.client.auth.*;
import com.cervinodata.client.models.*;
import com.cervinodata.client.api.AdvertisingDataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.cervinodata.com/api/v1");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AdvertisingDataApi apiInstance = new AdvertisingDataApi(defaultClient);
    String organisationUuid = "organisationUuid_example"; // String | Organisation uuid
    String format = "format_example"; // String | Output format
    try {
      String result = apiInstance.getAdAccounts(organisationUuid, format);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdvertisingDataApi#getAdAccounts");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AdvertisingDataApi getAdAccounts GET /data/ad-accounts/{organisationUuid} Return ad accounts by organisation
AdvertisingDataApi getAdCampaignReportPerDay GET /data/ad-campaign-report-per-day/{organisationUuid} Return ad campaign report per day by organisation
AdvertisingDataApi getAdCampaignReportPerOrganisationPerAccountPerDay GET /data/ad-campaign-report-per-organisation-per-account-per-day/{organisationUuids} Return ad campaign report per organisation per account per day
AdvertisingDataApi getAdCampaigns GET /data/ad-campaigns/{organisationUuid} Return ad campaigns by organisation
AnalyticsDataApi getViews GET /data/views/{organisationUuid} Return views by organisation
AnalyticsDataDefaultMetricsApi getAnalyticsReportPerCampaignPerDay GET /data/analytics-report-per-campaign-per-day/{organisationUuid} Return analytics report per campaign per day by organisation
AnalyticsDataDefaultMetricsApi getAnalyticsReportPerChannelGroupPerDay GET /data/analytics-report-per-channel-group-per-day/{organisationUuid} Return analytics report per channel group per day by organisation
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
AnalyticsDataDefaultMetricsApi getAnalyticsReportPerDevicePerDay GET /data/analytics-report-per-device-per-day/{organisationUuid} Return analytics report per device per day by organisation
AnalyticsDataDefaultMetricsApi getAnalyticsReportPerSourceMediumPerDay GET /data/analytics-report-per-source-medium-per-day/{organisationUuid} Return analytics report per source medium per day by organisation
AnalyticsDataGoalsApi getAnalyticsGoalReportPerCampaignPerDay GET /data/analytics-goal-report-per-campaign-per-day/{organisationUuid} Return analytics goal report per campaign per day by organisation
AnalyticsDataGoalsApi getAnalyticsGoalReportPerChannelGroupPerDay GET /data/analytics-goal-report-per-channel-group-per-day/{organisationUuid} Return analytics goal report per channel group per day by organisation
AnalyticsDataGoalsApi getAnalyticsGoalReportPerDevicePerChannelGroupPerOrganisationPerViewPerDay GET /data/analytics-goal-report-per-device-per-channel-group-per-organisation-per-view-per-day/{organisationUuids} Return analytics goal report per device per channel group per organisation per view per day
AnalyticsDataGoalsApi getAnalyticsGoalReportPerDevicePerDay GET /data/analytics-goal-report-per-device-per-day/{organisationUuid} Return analytics goal report per device per day by organisation
AnalyticsDataGoalsApi getAnalyticsGoalReportPerSourceMediumPerDay GET /data/analytics-goal-report-per-source-medium-per-day/{organisationUuid} Return analytics goal report per source medium per day by organisation
GenericDataApi getCampaignGroups GET /data/campaign-groups Return campaign groups
GenericDataApi getOrganisations GET /data/organisations Return organisations

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@cervinodata.com

You can’t perform that action at this time.