Skip to main content

Access Guide Reporting Data in Amazon S3

Learn how Guide provides enterprise-grade access to raw reporting data via Amazon S3 for integration into your internal BI tools.

Updated over a week ago

๐Ÿง  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.

However, teams may implement a lightweight readiness check using a common convention:

  1. Guide deletes any existing _SUCCESS file before writing begins

  2. Once all files are fully written, a new _SUCCESS file is created

  3. Your team can wait for the presence of the _SUCCESS file before initiating a read

โš ๏ธ Note: This does not guarantee full transactional safety. There is still a theoretical race condition if the file is read while the export is writing. For most cases, this lightweight pattern is sufficient โ€” but we recommend waiting a short buffer (e.g. 1โ€“2 minutes) after detecting _SUCCESS.


๐Ÿ”’ 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.

๐Ÿ‘‰ Sample S3 Export
โ€‹



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.

Did this answer your question?