Manage Data Exports

Members of the Administrators and Analytics Managers built-in groups can access the Data Exports page of the Coveo Administration Console to export usage analytics data such as clicks, groups, keywords, searches, and custom events (see Usage Analytics Data Exports).

The data is exported to a set of CSV files that can be imported using a third-party tool such as Microsoft Excel™ to perform advanced analysis or visualization.

Add an Export or Recreate an Existing Export

  • Exports data shows timestamps in GMT.

  • If you plan to create the same export on many occasions, you should add a schedule for exports instead.

  1. On the Data Exports page, click Add, and then select Export.

    If the Add button is grayed and unresponsive, you don’t have all of the required privileges to perform this action.

    OR

    Click an export to use as a starting point, and then in the Action bar, click Re-export

    The Re-export option is clickable when the export Status is Completed and when your Coveo organization export limit isn’t exceeded (see Maximum number of analytics data exports).

  2. In the Add a Data Export or Recreate an Export panel that appears:

    1. Click the box containing the actual date range to access the Report Period dialog, and then select the date range you want to review (see Set the Period to Review Search Usage Data).

      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, so you click Next.

    2. Access the dialog to add global dimension filters by clicking Add-Filter, and then create one or more dimension filters to scope the exported data (see Add Global Dimension Filters).

      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

    3. 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.

    4. 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.

      Origin 1 (Page/Hub)

      By default, exports show the dimension API names.

      For example, originLevel1.

    5. In the right section of the panel, expand the Filter Dimensions to Export section.

    6. In the Filter Dimensions to Export section, ensure that the check box of all relevant dimensions for your use case are selected.

      • You can use the Filter box or the All (n) drop-down menu to find the dimensions you’re looking for.

      • By default, all dimensions are selected.

      • Not all dimensions support to be exported.

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

    7. Click Add Export.

      The export appears in the Exports tab table.

      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

You can’t download a failed export.

On the Data Exports page, in the Exports tab, in the list of exports, click the export that you want to review, and then in the Action bar, click Download to download the ZIP file on your computer.

By default, the exported analytics database contains five tables (see Reference).

Delete an Export

  1. On the Data Exports page, in the Exports tab, in the list of exports, click the export that you want to remove, and then in the Action bar, click Delete.

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

Add a Schedule for Exports

  • Exports data shows timestamps in GMT.

  • A maximum of three exports are kept per schedule. You have to delete an export created related to the schedule for a new scheduled export to be created.

  • You Coveo organization is limited on the number of exports. 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.

  1. On the Data Exports page, select the Schedules tab.

  2. In the Schedules tab:

    • Click Add, and then select Schedule.

      If the Add button is grayed and unresponsive, you don’t have all of the required privileges to perform this action.

      OR

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

  3. In the Add a Schedule or Edit a Schedule panel that appears:

    1. Under Recurrence, select the rate at which exports are created between the following values: Daily, Weekly, or Monthly.

      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.

    2. Access the dialog to add global dimension filters by clicking Add-Filter, and then create one or more dimension filters to scope the exported data (see Add Global Dimension Filters).

      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

    3. 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.

    4. 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.

      Origin 1 (Page/Hub)

      By default, exports show the dimension API names.

      For example, originLevel1.

    5. In the right section of the panel, expand the Email notification section.

    6. In the Email notification section:

      1. Select the Notify when data export ready check box when you want to be notified or notify colleagues each time an export is created.

      2. Click the Users to notify box, and then:

        • Select one or more emails of Coveo organization members.

          OR

        • Start writing and then select suggested emails as you type.

          OR

        • Enter one or more emails.

          Press Enter to add emails.

    7. Expand the Filter Dimensions to Export section.

    8. In the Filter Dimensions to Export section, ensure that the check box of all relevant dimensions for your use case are selected.

      • You can use the Filter box or the All (n) drop-down menu to find the dimensions you’re looking for.

      • By default, all dimensions are selected.

      • Not all dimensions support to be exported.

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

    9. Click Add Schedule or Save.

Review Exports Created by a Schedule

  1. On the Data Exports page, select the Schedules tab.

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

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

Download the Last Export Created by a Schedule

  1. On the Data Exports page, select the Schedules tab.

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

See Reference for more details about the data export content.

Delete a Schedule

  1. On the Data Exports page, select the Schedules tab.

  2. In the Schedules tab, select the line of the schedule you want to remove.

  3. In the Actions bar, click More, and then select Delete.

  4. In the confirmation prompt that appears, click Yes.

Review Data Export Management Activities

The Activity panel list presents the data export management activities in the reverse chronological order. Each row represents an activity, indicating when it occurred, the display name of the affected export, what was done (created, updated, deleted), and by who or what (user, schedule).

You can review the creation, change, and deletion history of your data exports. To do so, on the Data Exports page, click Activity (see Review Events Related to Specific Coveo Administration Console Resources).

If the Activity icon is grayed and unresponsive, you don’t have all of the required privileges to perform this action.

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).

</div>

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
Searches
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 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 Data Exports 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

Analytics - Data exports

Edit
Recommended Articles