Changelog

The API references now come from the OpenAPI specs that the Tenjin API serves: Campaign Management API 2.1.0, Reporting Metrics API 2.1.0 and Raw Data Exports API 1.7.1. The only breaking change is the removal of v1 of the Campaign Management API and the Reporting Metrics API. The specs are now generated differently, so their differences from the earlier spec files are large. The Raw Data Exports API spec is now OpenAPI 3.0 instead of Swagger 2.0. The site documents only the current version of each API.

Added subscription metric definitions to the Spend endpoint: new_trials, new_subscriptions, new_subscriptions_revenue, renewals, renewals_revenue, all_subscriptions_revenue, and cancelled_subscriptions. Subscription revenue now also folds into the daily All Revenue and All Revenue per DAU (ARPDAU) metrics and the N-day All LTV, LTV / User, ROAS, and ROI metrics, so their labels change from "(Ad Network + IAP)" and "(Ad Mediation + IAP)" to "(Ad Network + IAP + Subscriptions)" and "(Ad Mediation + IAP + Subscriptions)". Predicted LTV (pltv_Nd) is unchanged.

Shortened export retention from 30 days to exactly 24 hours after creation. Added expires_at, the exact expiry timestamp (ISO8601), to export responses — after it passes, the download endpoint returns 410 Gone and the export's files are deleted. expiration_date is deprecated in favour of expires_at.

Added app_open, custom_events, in_app_purchases, and subscription to the list of allowed values for the event_type_groups field in the postV1Exports endpoint.

The list exports endpoint (GET /v1/exports) is now paginated and ordered newest first.

Renamed event_types to event_type_groups to better match the business logic. The new name replaces the old one; event_types stays available in deprecation mode for backwards compatibility.

Changed the download export file endpoint to take the S3 URI as a Base64url-encoded path parameter (encoded_uri) instead of a URL-encoded query parameter (s3_uri).

Removed user_email field from the DataExport model.

Added creative as a supported group_by dimension for the Spend endpoint.

Renamed Data Exports API to Raw Data Exports API.

Added ad_network_ids as a filter parameter to the raw data export endpoints, allowing exports to be scoped to specific ad networks.

Launch of the Raw Data Exports API.

Added user_filter_default and user_filter_editable attributes to the Callback Group Templates endpoint.

Added S2S Callbacks to the Campaign Management API. Callback Group Templates endpoints modified to return event instead of event_type. Callback Groups endpoints modified to accept event as a parameter.

Added Callback Settings, Callback Groups, and Callback Group Template endpoints to the Campaign Management API. These will be used to manage callbacks in place of the existing Callback and Callback Template endpoints, which will be deprecated in future versions.

Added Total related metrics.

Added Ad Mediation Revenue and related metric definitions to the Spend endpoint.

In preparation for some upcoming reporting and backend changes, we have removed the ability to edit campaign tags via the Campaign Management API. All other campaign attributes work as before.

Removed documentation referencing platform as a supported group by dimension as the backend does not support it.

Removed support for windows as a platform option.

Callbacks accept user_filter as a string field.

General Availability for SKAN Apple endpoint. Customers need access to the Reporting Metrics API to access the SKAN Apple endpoint.

SK Ad Network reports now support the following metrics introduced in SKAdNetwork 3.0: assists, redownload_assists, and first_download_assists.

SK Ad Network reports now support campaign as a group_by dimension, which returns the campaign_id, campaign_name, and remote_campaign_id attributes.

SK Ad Network reports now support the fidelity_type group by dimension and the following metrics: redownload_count, redownload_cv_total, redownload_cv_avg, first_download_count, first_download_cv_avg, first_download_cv_total.

App records now support a destination_url attribute for the android_other platform.

General Availability for the SK Ad Network endpoints. Customers still need access to the Reporting Metrics API or Campaign Management API to access the SK Ad Network endpoints within each API.

Added new endpoints for pulling SK Ad Network objects and reports.

These endpoints are only available to customers participating in our SK Ad Network closed beta. Contact your account manager if you are interested in participating.

Campaign records now have hidden attribute returned in the payload.

You can now group by ad placements (group_by = ad_placement) for ad revenue reports.

GET requests for campaign records will now return any associated tags for each campaign, and the POST request to create campaigns now accept a tags parameter. We have also added new API paths to add or remove tags from campaigns, at PATCH /campaigns/:id/tags. Learn more about targeting tags.

We added a limit to the max number of records that can be returned per page for GET requests that return a list of records. For example, GET /apps or GET /channels. You can see the limit by viewing the per_page query parameter in the documentation.

In Version 2.0.1 and Version 1.0.1 we have added rate limiting to the Reporting Metrics API. Reporting Metrics API requests are rate limited to prevent abuse and ensure stability. Each access token may make up to 100 reporting requests per minute. The Reporting Metrics API will respond with a 429 status code for subsequent requests above the rate limit. The Campaign Management API did not change and is not rate limited at this time.

In Version 2.0.0 we added some breaking functionality to the Reporting Metrics API, but the Campaign Management API did not change. Here is what changed in the Reporting Metrics API:

• Added Campaign x Country breakdown for spend reports.
• Pagination to help prevent timeouts due to the size of data in certain responses.
• Deprecated the https://www.tenjin.io/config/:version endpoint and now recommending all customers switch to using https://api.tenjin.com/:version.

Launch of the Campaign Management API and Reporting Metrics API.