🧠 Overview
For enterprise customers, Guide offers the ability to export interview and scheduling data to a dedicated Amazon S3 bucket, enabling you to integrate raw data into your internal business intelligence tools (e.g., Snowflake, Tableau, Looker).
This setup is ideal for companies who want to supplement or replace in-app analytics with custom dashboards or internal reporting pipelines.
🗂️ Folder Structure & File Format
Each S3 bucket is organized by table, with a separate folder for each dataset. Within each folder, data is exported in gzip-compressed CSV files (.csv.gz).
Tables include interview-level, candidate-level, and event-level data
Each folder typically contains ~4 partitions per export job to support scalable parallel reads
Upon request, Guide can consolidate exports into a single CSV file per table.
🔄 Export Frequency & Update Behavior
All S3 exports are currently full dataset exports, not incremental deltas. That means:
Each export contains the complete snapshot of all records
Updated records will replace previous values (entities retain consistent IDs across exports)
This makes it easy to treat each export as a fresh source of truth without needing to reconcile deltas
✅ File Readiness and Handshake Pattern
Guide does not yet support a formal “handshake” or delivery confirmation mechanism to indicate when all files are fully written and ready for consumption.
This support document will be updated when there is a mechanisms for detecting readiness.
🔒 Access and Security
Each S3 bucket is provisioned privately and securely, with customer-specific credentials and permissions. Your team will receive:
Bucket URL
Access keys and credentials
Sample schema reference (if needed)
Guide follows AWS best practices for data security and access control in all enterprise exports.
🧾 Understanding the Exported Data Tables
🔍 Sample Data Format
Find below a sample export to help your team review the structure of the data before integration. These exports are anonymized and include example rows across key tables (e.g., interviews, candidates, interviewer availability).
Please click the file and request access.
Guide’s S3 reporting export includes multiple structured CSV files, each representing a key part of your scheduling and interview coordination data. Here’s a quick overview of the most common files you’ll receive:
📅 Interviews.csv
Contains one row per confirmed interview. This is your central table for interview analytics. Includes:
Candidate ID, job title, interview stage
Interviewer assigned, scheduled time
Calendar metadata and coordination method
📬 Scheduling_requests.csv
Tracks every interview scheduling request made in Guide.
Includes:
Request creation time and requestor
Associated job and stage
Whether the request was handled manually or by automation
Status and time to schedule
📤 Availability_requests.csv
Logs every time Guide requested availability from a candidate.
Includes:
Request timestamps
Whether the candidate responded and how
Availability method (self-schedule vs. coordinator-led)
⚙️ Automated_actions.csv
Captures every scheduling action taken by Aria, Guide’s AI assistant.
Includes:
Action type (e.g. assign panel, propose slot, auto-schedule)
Success/failure flag
Associated request ID and timestamp
🧑💻 Interviewer_pools.csv
Represents the state of your interviewer pools — which interviewers are eligible for which types of interviews.
Includes:
Interviewer IDs and assigned tags
Pool name, stage, and configuration metadata
📈 Interviewer_pool_load.csv
Tracks the load and availability of interviewers in each pool over time.
Includes:
Weekly interview cap
Interviews completed vs. scheduled
Pool saturation and balance metrics
🧾 Interviewer_pool_events.csv
Logs changes made to interviewer pools (e.g. new assignments, removals).
Includes:
Event type (add/remove)
Timestamp and user who made the change
Interviewer and pool involved
These tables are designed to be joined using common keys such as request_id, candidate_id, or interview_id, depending on your analytics needs.
If you need a data dictionary or sample schema reference for integration, contact your Guide CSM or Support team.
SOP: S3 Bucket Setup for Guide Customers
Overview
This SOP outlines the end-to-end process for setting up an Amazon S3 data export for a Guide customer. S3 is Guide's primary method for giving customers programmatic access to their raw reporting data for use in BI tools like Snowflake, Tableau, or Looker.
Note: All exports include 100% of data available in the Guide web client.
Step 1: Customer Requests S3 Access & Provides Contact Info
The customer (typically via their CSM Slack channel or direct outreach) expresses interest in the S3 export. The customer's data or analytics team reviews the overview doc and confirms they'd like to proceed.
You'll need to provide the names/contact info for the team members who need S3 access (e.g., data engineers, analysts) and provide this to your Guide CSM.
Step 2: Guide Provisions the S3 Bucket
Owner: Guide team
Timeline: ~10 business days to provision (2 calendar weeks)
Guide provisions a privately and securely provisioned S3 bucket with customer-specific credentials and permissions, following AWS best practices.
Step 3: Guide Shares Credentials with You Once Ready
Once provisioned, Guide shares the following with the customer's designated data team:
S3 bucket URL
Access keys and credentials
Sample schema reference (if requested)
Step 4: Customer Connects S3 to Their BI Tool
From here, it's up to your BI/data team to:
Connect the S3 bucket to their BI/data pipeline (Snowflake, Tableau, Looker, Databricks, etc.)
Build any data transformations or custom dashboards they need
Guide is available for questions but this step is fully customer-owned.
Key Details about the S3 Setup
Topic | Details |
Export format | Gzip-compressed CSV files (.csv.gz), organized by table |
Export frequency | Full dataset snapshot exported every 2 hours (starting at midnight, 2am, 4am, etc.) |
Recommended pull time | 2am or later each day (exports take ~75 minutes to run) |
Export type | Full snapshot (not incremental deltas) — each export replaces the previous |
Consistent IDs | Entities retain consistent IDs across exports for reliable joins |
Data direction | One-directional: Guide → S3 only (not back to ATS) |
Cost | No additional cost |
Only export option | S3 and in-product CSV downloads are the only export options today; no public API. |
Data Tables Available in S3
Table | Description |
interviews.csv | One row per confirmed interview — the central table for interview analytics |
scheduling_requests.csv | Every scheduling request made in Guide, including method and time-to-schedule |
availability_requests.csv | Every time Guide requested availability from a candidate |
automated_actions.csv | Every action taken by Aria (Guide's AI), with success/failure flags |
interviewer_pools.csv | State of interviewer pools — eligibility, tags, and config |
interviewer_pool_load.csv | Load tracking per pool — caps, completions, saturation |
interviewer_pool_events.csv | Change log for interviewer pool membership |
Tables are designed to be joined using common keys: request_id, candidate_id, or interview_id.
Common Customer FAQs
Q: Is S3 the only way to get raw data out of Guide? Yes — Guide currently offers S3 export and in-product CSV downloads. There is no public reporting API.
Q: Can Guide drop data to our SFTP server instead? Not currently — S3 is the only programmatic export option. Customers can re-route data from S3 to their own infrastructure from there.
Q: Is there an incremental/delta export option? No — all exports are full dataset snapshots.
Q: Can Guide consolidate multiple partition files into one CSV per table? Yes, upon request.
Q: Is there a delivery confirmation / "handshake" when files are ready? Not yet — Guide does not currently support a formal delivery confirmation mechanism. This is on the roadmap.