DocumentationAudience ManagerAudience Manager User Guide

CSV Files for Overlap Reports csv-files-for-overlap-reports

Last update: Tue Apr 13 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

You can request a .csv file for an Overlap Report when that report reaches its 1-million record limit. A report may have reached this limit when you see an “Unexpected error has occurred” message. Contact Customer Care to request a compressed .csv file, which you can import and work with in your own database system. Files are available for segment-to-segment, segment-to-trait, and trait-to-trait overlap reports.

File Name Metadata file-name-metadata

The following table list and describes the file naming conventions and file extensions use in an overlap .csv file. In the examples, italics indicates a variable placeholder.

Metadata Element
Description
File Extension
Overlap report files are gzip compressed and have a .gz file extension. You must add the .csv extension to the file after decompression.
File Name

File name syntax:

  • Segment-to-segment files: S2S_overlap_partner ID_yyyy-mm-dd_date range
  • Segment-to-trait files: S2T_overlap_partner ID_yyyy-mm-dd_date range
  • Trait-to-trait files: T2T_overlap_partner ID_yyyy-mm-dd_date range
Date Range

The date range for a report is a 5-digit ID that includes:

  • 70000 for a 7-day report.
  • 30000 for a 30-day report.
Multiple Files
We increment the last digit in the file name if a report contains multiple files.
Examples

File name examples for a single report:

  • Single, 7-day file: S2S_overlap_12345_2017_01_14_70000.gz
  • Single, 30-day file: S2S_overlap_12345_2017_01_14_30000.gz

File name examples for a report with multiple files:

  • S2S_overlap_12345_2017_01_14_70000.gz
  • S2S_overlap_12345_2017_01_14_70001.gz
  • S2S_overlap_12345_2017_01_14_70002.gz

File Contents file-contents

In the file, string data is enclosed in double quotes. See the mock data below. This has been truncated for brevity and to fit the screen.

//File header
"segment_id1","segment_name1","segment_id2","segment_name3,"range_id",...
//File body
"123456","segmentA","654321","segmentB","30","yyyy-mm-dd","98765",...

Segment-to-Segment Report Records segment-segment-records

A data file for your Segment-to-Segment Overlap Report contains the following records.

Label
Description
segment_id1
The ID of the segment you're comparing to the baseline segment.
segment_name1
The name of the segment you're comparing to the baseline segments.
segment_id2
The ID of your baseline segment. The baseline segment is the segment you want to compare with other segments.
segment_name2
The name of the baseline segment you're comparing to other segments.
rangeid

You can get reports for 7- and 30-day look-back intervals. The rangeid corresponds to the time intervals shown below.

  • 7: 7-days
  • 30: 30-days
datethru
The processing date for a report.
segment_uniques1
The number of unique users in the segment you're comparing to the baseline segment.
segment_uniques2
The number of unique users in the baseline segment.
overlap_uniques
A total count of the overlap of unique users between the baseline segment and the other segments selected for comparison.
Overlap_perc
The % overlap of unique users between the baseline segment and the other segments selected for comparison.

Segment-to-Trait Report Records segment-trait-records

A data file for your Segment-to-Trait Overlap Report contains the following records.

Label
Description
trait_id
Trait ID.
trait_name
Trait name.
dataprovider_type

The data provider ID. IDs include:

  • 1st Party
  • 3rd Party
dataprovider
Name of the data provider.
rangeid

You can get reports for 7- and 30-day look-back intervals. The rangeid corresponds to the time intervals shown below.

  • 7: 7-days
  • 30: 30-days
datethru
The processing date for a report.
segment_uniques
The number of unique users in the selected segment.
trait_uniques
The number of unique users in a trait. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
overlap_uniques
The number of unique users shared between the selected segments and traits. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
trait_uniques_overlap_perc
% of unique users that overlap between the trait and segment. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
segment_uniques_overlap_perc
% of uniques users that overlap between the segment and trait. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.

Trait-to-Trait Report Records trait-trait-records

A data file for your Trait-to-Trait Overlap Report contains the following records.

Label
Description
overlap_trait_id
The ID of the trait you're comparing to the baseline trait.
overlap_trait_name
The name of the trait you're comparing to the baseline trait.
base_trait_id
The ID of your baseline trait. The baseline trait is the trait you want to compare with other traits.
base_trait_name
The name of the baseline trait you're comparing to other traits.
dataprovider_type

The data provider ID. IDs include:

  • 1st Party
  • 3rd Party
dataprovider
Name of the data provider.
rangeid

You can get reports for 7- and 30-day look-back intervals. The rangeid corresponds to the time intervals shown below.

  • 7: 7-days
  • 30: 30-days
datethru
The processing date for a report.
overlap_trait_uniques
The number of unique users shared between the selected traits. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
base_trait_uniques
The number of unique users in a base trait. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
overlap_uniques
The number of unique users shared between the selected traits. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
overlap_trait_uniques_overlap_perc
% of unique users that overlap between the selected traits. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
base_trait_uniques_overlap_perc
% of uniques users that overlap between the selected traits. In the UI report, this number appears in the pop up window when you hover over a trait in the heatmap results.
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695