Skip to main content
POST
Export Analytics Data
Export analytics data for questions, out-of-context queries, and referenced sources. The data can be exported in different formats and filtered based on various criteria.

Headers

string
required
Your API key for authentication. You can obtain your API key from the Gurubase dashboard.

Request Body

string
default:"xlsx"
required
Format of the export file. Possible values: xlsx, csv, json
  • xlsx: Microsoft Excel format
  • csv: Compressed ZIP containing CSV files
  • json: JSON format
string
default:"today"
Time period for the analytics data. Possible values:
  • today: Current day
  • yesterday: Previous day
  • 7d: Last 7 days
  • 30d: Last 30 days
  • 3m: Last 3 months
  • 6m: Last 6 months
  • 12m: Last 12 months
object
Filters for different types of data

Response

The response will be a file download with the appropriate content type header based on the export_type:
  • XLSX: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • CSV: application/zip
  • JSON: application/json
Each answered and unable-to-answer row includes an Auto-Generated column (Yes/No in XLSX and CSV, auto_generated boolean in JSON) that flags questions fired automatically by an integration (for example, the Zendesk app asking a ticket the moment it is opened) rather than typed by an end user. Each export also adds an auto-generated distribution (type, count, percentage) for questions and for unable-to-answer entries: the Auto-Gen Dist - Questions and Auto-Gen Dist - Unable sheets in XLSX, auto_generated_distribution_questions.csv and auto_generated_distribution_unable_to_answer.csv in CSV, and an auto_generated_distribution object with questions and unable_to_answer in JSON. Empty distributions are omitted.