Context API Insights

How it works

The Context API Insights tab displays visualizations and data about Context API engine writes and engine reads. An engine write occurs when visitor data used in an engine is updated. An engine read occurs when a GET request is made to the endpoint.

If you turn off the Context API Insights feature, the dashboard and its data are deleted 30 days after you publish this change. To retain your data, re-enable the feature within this period.

The Context API Insights tab displays the following visualizations and data:

• Engine reads
• Engine writes
• Engine reads and writes
• Engine write requests that exceeded the data limit and were not written
• Average size of engine writes that exceeded the data limit
• Total reads over time
• Total writes over time
• Total reads by engine
• Total writes by engine
• Total data in bytes not written over time (due to write requests that exceeded the data limit)

The following figure shows an example of the visualizations and data shown in the Context API Insights tab:

This screenshot shows the previous product name “Moments API”. It will be updated when the product UI is updated.

Write requests that exceed the data limit

If a large number of audiences, badges, and attributes are specified for an engine, the size of an engine write can exceed the maximum amount of data that can be stored per visitor per engine. Using names for audiences, badges, and attributes can also increase the write size. For more information, see Limits.

If engine writes are exceeding the maximum amount of data per visitor per engine, you can reduce the write size in one of the following ways:

• Use attribute IDs instead of names for audiences, badges, and attributes.
• Divide the data between two or more engines.

Select a date range

The default Date Range for the data and visualizations is Last 30 days. To select a new Date Range, use the following steps:

1. Click the Controls bar.
   

   

This screenshot shows the previous product name “Moments API”. It will be updated when the product UI is updated.

1. Click the current Date range.
2. Do one of the following:
   • To display data by weeks, months, quarters, or years, click Relative by and select an option.
   • To display data for an absolute date range, click Absolute date range, then select the beginning and ending dates.
     The display is refreshed with the new data.
3. To close the list, click the Controls bar.

Select an engine

The default Engine for the data and visualizations is All. To select a specific engine, use the following steps:

1. Click the Controls bar.
   

   

2. Click the current Engine and select a new engine.
   The display is refreshed with the new data.
3. To close the list, click the Controls bar.

Updates to the Context API Insights tab

The visuals shown in the Context API Insights tab are also available in Tealium Insights as the Context API Dashboard. The Context API Insights tab displays a message when the dataset structure or capacity needs attention.

Update the Context API Insights dataset

When the dataset structure for Context API Insights has been updated, a message is displayed on the Context API Insights tab indicating that the dataset structure is obsolete and needs to be updated.

To update the dataset, use the following steps:

1. In the message, click Update.
2. In the confirmation message, click Submit.
   When the dataset update is completed, a success message is displayed.

Refresh the Context API Insights dataset

When the data set for the Context API Insights tab has reached its maximum capacity, a message is displayed indicating that the dataset has reached its capacity limit and needs to be refreshed.

To refresh the data in the dataset, use the following steps:

1. In the message, click Run Refresh.
2. In the confirmation message, click Submit.
   The dataset refresh is executed in the background. When the refresh is completed, the dataset will contain only the latest 800 million rows.