Prerequisites

The Terminus Platform API is available to all Terminus customers with access to the Ad Experiences product. Additionally, for Site Visit data to populate in the Tactic Account Performance report, you must have the Visitor ID tracking script installed on your website.

---

Article quick links:

 

API Offering Overview

The Terminus Platform API allows Terminus users to export Terminus advertising and website engagement data to enable stronger cross-departmental attribution, and augment Terminus metrics with other martech data points for broader stakeholder visibility. 

At this time, the following data will be available for export via our API:

  • An export of advertising Clicks, Impressions, and Spend per day, at the tactic-level, for the last 30 days for all Terminus display* advertising tactics
  • An export of advertising Clicks, Impressions, and Spend, at the account-level, for the last 30 days for all display* tactics. This export will also include website engagement data per account, as tracked by our Visitor ID product

* NOTE: At this time, these exports will only include data for display advertising tactics; they will not include data for Terminus retargeting, global, or LinkedIn-integration tactics.

For additional details on the data available for export, please review this section of the article.

In this article, we’ll review several callouts and best practices for our API offering, as well as directions for accessing our developer portal, which will house the most up-to-date and detailed information related to the Terminus Platform API.

 

Accessing the Developer Portal

Terminus’s developer documentation will be made publicly accessible at developer.terminus.com



Additional details about the portal:

  • The developer portal is where we will document our key API usage scenarios for interacting with the Terminus Platform API
  • The portal will include documentation for all of our publicly available API endpoints
  • The portal includes tactical instructions for things like authentication details, error response codes, and how to address errors, and is intended to be an interactive portal for our developer end users
  • The portal includes dynamic code samples in a number of programming languages

Documentation in the portal can be accessed using the search bar, or by clicking on the Docs link directly from the homepage.


Key Feature Callouts

Authentication

The Terminus API uses API keys for authentication. Please reach out to the Terminus Support team at support@terminus.com with a request for "Terminus Platform API Key" to have your organization's unique API key generated.


Errors

It is generally recommended to record the error that you receive along with the Request ID so that you have them to reference when contacting our Support Team. Please see the Request ID section below for further details.


Request IDs

Each API request has a request identifier associated with it. If you need assistance regarding a particular request, we ask that you please provide the request identifier along with your inquiry to support@terminus.com. You can find this value in the response headers, under terminus-request-id.

Bulk Exports

Export Types

Currently, the primary offering for accessing the Terminus Platform API is via Bulk Export. Customers must be actively using the Terminus Ad Experiences product for these exports to produce relevant data. The available export types include:

Daily Tactic Performance

  • Recommended Execution Schedule: Daily or weekly
  • This report contains clicks, impressions, and spend per display* tactic per day for the last 30 days. It will not include any account-level information. This data can be used to measure the performance of the ad tactic itself (creative, messaging, segmentation, etc.)
  • Data is encoded in the file in CSV format following: https://tools.ietf.org/rfc/rfc4180.txt with a header row containing the columns listed below:

Display Tactic Account Performance

  • Recommended Execution Schedule: Daily or weekly
  • This report contains clicks, impressions, and spend per account per display* tactic per day for the last 30 days. This export will also include website engagement data per account, as tracked by our Visitor ID product. This data can be used to understand which specific accounts are interacting with advertising tactics, and your website
  • Data is encoded in the file in CSV format following: https://tools.ietf.org/rfc/rfc4180.txt with a header row containing the columns listed below:

Additional Notes: 

  • The first_visit_date and last_visit_date fields will represent the first and last website visit dates within the specified date range of the report.
  • At this time, these exports will only include data for display advertising tactics; they will not include data for Terminus retargeting, global, or LinkedIn-integration tactics.  


Job Scheduling

An Export Job for a specific type can only be scheduled once per account and the maximum interval an Export Job can be run is once per day. Exported data for the last 48hrs is subject to change.

Since Exports can only be executed on a daily basis, the input value for minutes and hours will be ignored if specified.

All scheduled Export Jobs initiate at 12:00 AM UTC.


Export Jobs

All specific details related to export jobs and responses, including request and response samples, can be found in the developer portal.


Each response will also include a drop down view with additional information:

Once an export job is complete, the data can be imported into a business intelligence tool, a data visualization platform, another martech tool, or even a customer data warehouse for further analysis.

Was this article helpful?
1 out of 1 found this helpful

Comments

0 comments

Article is closed for comments.