Manage Data Exports

In the Data Exports tab of the Raw Data (platform-eu | platform-au) page of the Coveo Administration Console, you can extract and download your UA data to a CSV file for further analysis.

Add or Edit an Export

In the Data Exports tab of the Raw Data (platform-eu | platform-au) page, do one of the following:

  • To create a new export, click Create CSV Export.

  • To use an existing export as a starting point, click the export, and then click Recreate a Data Export in the Action bar.

Notes

Set Report Period

In the Add/Recreate a Data Export panel, click the date range to access the Report Period dialog, and then select the date range you want to review.

Note

You can select a period that’s incomplete (e.g., the current month), in which case your date range selection will always include the latest available events until the period ends (e.g., the first day of the following month).

For example, you’re reviewing data per Month and want to see how statistics are trending for the first two weeks of the current month, therefore you click Next.

Add Global Dimension Filters

Click Icon-Filter to access the dialog to add global dimension filters, and then create one or more dimension filters to scope the exported data.

Example

You want to export all events (searches, clicks, custom, keywords, groups) that happened in Canada that aren’t Page Views (logged each time a visitor views a page on your website), so you add the following filters:

Country is Canada

Custom Event Value is not PageView

"Content to Export" Section

Under Content to export, choose the type of usage analytics data to export by selecting one or more of the following check boxes:

  • <n> Searches

  • <n> Clicks

  • <n> Custom events

  • <n> Groups

  • <n> Keywords.

where <n> represents the number of each event to be exported for the selected report period and applied filters.

The export ZIP file contains one CSV file per selected option.

"Option" Section

Select the Use dimension display name check box if you want the export to show the same dimension names as they appear in UA reports, for example, Origin 1 (Page/Hub).

Note

By default, exports show the dimension API names.

For example, originLevel1.

"Filter Dimensions to Export" Section

In the right section of the panel, expand the Filter Dimensions to Export section, and then ensure that all relevant dimensions are selected.

Notes
  • You can use the Filter box or the Origin drop-down menu to find the dimensions you’re looking for.

  • Not all dimensions support to be exported.

  • In each CSV file contained in the export, each selected dimension appears in a single column.

Complete Export

When you’re done adding or editing the export, click Add data export.

The export appears in the Data Exports tab table.

Note

When you create an export starting from an existing one, a new export is generated, meaning the original export is still available.

Download an Export

By default, the exported analytics database contains five tables.

  1. In the Data Exports tab of the Raw Data (platform-eu | platform-au) page, in the list of exports, click the export that you want to review, and then click Download in the Action bar to download the ZIP file on your computer.

  2. In the Are you sure dialog, click Confirm.

Note

You can’t download a failed export.

Delete an Export

  1. In the Data Exports tab of the Raw Data (platform-eu | platform-au) page, in the Past exports section, click the export that you want to delete, and then click Delete in the Action bar.

  2. In the confirmation prompt that appears, click Delete.

Review Past Exports

The Past Exports section in the Data Exports tab of the Raw Data (platform-eu | platform-au) page presents the data export management activities in reverse chronological order. Each row represents an export, indicating the following export details:

  • Set period

  • Applied filter(s) (if any)

  • Creation date

  • Author

  • Status

  • Size

Add a Schedule for Exports

  1. In the Data Exports tab of the Raw Data (platform-eu | platform-au) page, select Schedules.

  2. In the Schedules section, do one of the following:

    • Click Create Schedule.

    • Click a schedule to use as a starting point, and then click More > Edit in the Action bar.

Notes
  • If the Create Schedule button is grayed out and unresponsive, you don’t have all of the required privileges to perform this action.

  • Your Coveo organization is limited on the number of exports allowed. When you see the following Status: The export limit is exceeded for your account., delete existing exports or contact Coveo Support to upgrade your limit.

Recurrence

In the Recurrence section of the Add/Edit a Schedule panel, select the rate at which exports are created between the following values: Daily, Weekly, or Monthly.

Notes
  • Exports are added at the end of the period referred by the selected recurrence. For example, when you select Daily, exports are added after midnight of each day.

  • An export scheduled with a recurrence counts as a new export every time it runs. For example, when you select Daily, the export added after midnight is considered a new export.

  • A maximum of three exports are kept per schedule. The oldest export is automatically deleted when the maximum is reached.

"Filters" Section

Click Icon-Filter to access the dialog to add global dimension filters, and then create one or more dimension filter to scope the exported data.

Example

You want to export all events (searches, clicks, custom, keywords, groups) that happened in Canada that aren’t Page Views (logged each time a visitor views a page on your website) so you add the following filters:

Country is Canada

Custom Event Value is not PageView

"Content to Export" Section

Choose the type of UA data to export by selecting one or more of the following check boxes:

  • <n> Searches

  • <n> Clicks

  • <n> Custom events

  • <n> Groups

  • <n> Keywords.

    where <n> represents the number of each event to be exported for the selected report period and applied filters.

Note

The export ZIP file contains one CSV file per selected option.

"Option" Section

Select the Use dimension display name check box, when you want the export to show the same dimension names as they appear in usage analytics reports, for example, Origin 1 (Page/Hub).

Note

By default, exports show the dimension API names.

For example, originLevel1.

"Email Notification" Section

  1. In the right section of the panel, expand the Email notification section, and then select Notify when data export ready when you want to be notified or notify colleagues each time an export is created.

  2. Click Members to notify, and then select or type the email adresses to which notifications will be sent.

"Filter Dimensions to Export" Section

Expand the Filter Dimensions to Export section, and then ensure that all relevant dimensions are selected.

Notes
  • You can use the Filter box or the Origin drop-down menu to find the dimensions you’re looking for.

  • By default, all dimensions are selected.

  • Not all dimensions can be exported.

  • In each CSV file contained in the export, each selected dimension appears in a single column.

Complete Schedule

When you’re done adding or editing the export, click Add Schedule or Save.

Review Exports Created by a Schedule

  1. In the Data Exports tab of the Raw Data (platform-eu | platform-au) page, click Schedules.

  2. In the Schedules section, click the desired schedule, and then click View exports in the Action bar.

  3. In the View Exports From Schedule panel, you can perform the same actions as in the Past exports section, such as downloading and deleting exports.

Download the Last Export Created by a Schedule

  1. In the Data Exports tab of the Raw Data (platform-eu | platform-au) page, click Schedules.

  2. In the Schedules section, click a schedule, and then click Download last export in the Action bar.

See Reference for more details about the data export content in the CSV file.

Delete a Schedule

  1. In the Data Exports tab of the Raw Data (platform-eu | platform-au) page, click Schedules.

  2. In the Schedules section, click the line of the schedule you want to remove, and then click More > Delete in the Action bar.

  3. In the confirmation prompt that appears, click Delete.

Reference

The five tables in the CSV files contain columns titled with the API names of the dimensions you use in reports. Therefore, knowing which API name refers to which dimension can be difficult. The following tables list the API names and the actual dimensions they refer to in alphabetical order.

In addition to these default columns, any created dimension will have its own column (see Manage Dimensions on Custom Metadata).

click Table

API name Dimension

anonymous

Is Anonymous

cause

Click Cause

c_facettitle

Facet Title

c_facetvalue

Facet Value

city

City

clickId

N/A

This column contains the unique ID for each click event.

clickRank

Click Rank

collectionName

Collection Name

country

Country

customDatas

N/A

This column contains all custom dimensions and their value, displayed in the following format and separated by comma: "customDimensionName":"customDimensionValue"

datetime

Click Date Time

device

Device

deviceCategory

Device Category

documentTitle

Document Title

documentUrl

Document URL

language

Language

mobile

Is Mobile (deprecated)

originContext

Origin Context

queryPipeline

Query Pipeline

region

Region

searchId

N/A

The searchId is used in tables as the link between clicks and searches, keywords and searches, and groups and searches.

sourceName

Source Name

systemUriHash

Search Result (see Search Result (formerly Document))

userId

User ID

username

User Name

visitId

Visit ID

visitorId

Visitor ID

searches Table

API name Dimension

advancedQueryExpression

Advanced Query Expression

anonymous

Is Anonymous

batchId

N/A

Values in this column are destined for future use.

cause

Search Cause

city

City

country

Country

datetime

Search Date Time

device

Device (deprecated)

deviceCategory

Device Category

c_facettitle

Facet Title

c_facetvalue

Facet Value

id

N/A

The searchId is used in tables as the link between clicks and searches, keywords and searches, and groups and searches.

language

Language

mobile

Is Mobile

numberOfResults

Number of Results

originContext

Origin Context

pageNumber

Page Number

pageSize

N/A

Values in this column are destined for future use.

queryExpression

Query

queryPipeline

Query Pipeline

region

Region

responseTimeMS

N/A

This column contains the time taken by each query to return.

searchOriginLevel1

Origin 1 (Page/Hub)

searchOriginLevel2

Origin 2 (Tab)

searchOriginLevel3

Origin 3 (Referrer)

userAgent

User Agent

userId

User ID

username

User Name

visitId

Visit ID

visitorId

Visitor ID

withClicks

Has Clicks

withResults

Has Results

custom_events Table

The custom_events table is a special one that contains the non-search and non-click events in the system. Two different IDs can be used to create a relation between the custom events and the other tables:

  • The visitId can be used to relate a custom event with all queries and clicks in the same visit (for example, all the queries that preceded a Case Deflection event in a user visit on your community site).

  • The lastSearchId contains the query (if any) that immediately preceded the custom event. Therefore, it’s possible to do a relation between a custom event and the last query done by the user who triggered the custom event.

API name Dimension

anonymous

Is Anonymous

city

City

country

Country

customEventId

N/A

This column contains the unique ID for each custom event.

dateTime

Custom Event Date Time

device

Device

deviceCategory

Device Category

eventType

Event Type

customEventValue

Event Value

c_facettitle

Facet Title

c_facetvalue

Facet Value

language

Language

lastSearchId

N/A

The lastSearchId contains the query (if any) that immediately preceded the custom event. lastSearchId is used as a link between a custom event and the last query done by the user who triggered the custom event.

mobile

Is Mobile

originContext

Origin Context

region

Region

userId

User ID

userName

User Name

visitId

Visit ID

visitorId

Visitor ID

keywords Table

API name Dimension

keyword

Keyword

searchId

N/A

The searchId is used in tables as the link between clicks and searches, keywords and searches, and groups and searches.

groups Table

API name Dimension

groupName

Group

searchId

N/A

The searchId is used in tables as the link between clicks and searches, keywords and searches, and groups and searches.

Required Privileges

The following table indicates the required privileges to view and edit the elements of the Raw Data (platform-eu | platform-au) page and associated panels (see Manage Privileges and Privilege Reference).

Action Service - Domain Required access level

View data exports

Analytics - Analytics data
Analytics - Dimensions
Analytics - Data exports
Analytics - Named filters
Analytics - Permission filters

View

Manage data exports

Analytics - Dimensions
Analytics - Named filters
Analytics - Permission filters
Organization - Groups

View

Analytics - Analytics data

Push

Analytics - Data exports

Edit

What's next for me?