Skip to content

Repository files navigation

tap-rilla

tap-rilla is a Singer tap for the Rilla Voice API, built with the Meltano SDK for Singer Taps.

Installation

Install from source:

uv tool install git+https://github.com/MeltanoLabs/tap-rilla.git

Configuration

Required Settings

  • api_key: The API key to authenticate with the Rilla API
  • start_date: The earliest datetime from which to pull data (ISO 8601 format)

Optional Settings

  • end_date: The latest datetime from which to pull data (ISO 8601 format). If not specified, defaults to the current date and time.
  • users: An optional array of user email addresses to filter conversations. Only applies to the conversations stream. If provided and not empty, only conversation data for those users will be returned. If not provided or empty, all conversation data is returned.
  • date_type: Date type to filter by. Options are timeOfRecording or processedDate. Default: timeOfRecording

Configuration Examples

Basic configuration:

api_key: your_api_key_here
start_date: '2024-01-01'
end_date: '2024-12-31'

Filter conversations for specific users:

api_key: your_api_key_here
start_date: '2024-01-01'
users:
  - user1@company.com
  - user2@company.com

Use processed date instead of recording date:

api_key: your_api_key_here
start_date: '2024-01-01'
date_type: processedDate

A full list of supported settings and capabilities is available by running: tap-rilla --about

Streams

The tap extracts data from the following Rilla API endpoints:

conversations

  • Description: Exports conversation data recorded during the specified time range
  • Endpoint: POST /export/conversations
  • Supports user filtering: Yes (via users config parameter)
  • Pagination: Yes (25 records per page)
  • Primary Key: conversationId

teams

  • Description: Exports team data and usage during the specified time range
  • Endpoint: POST /export/teams
  • Supports user filtering: No
  • Pagination: No
  • Primary Key: id

users

  • Description: Exports user data and usage during the specified time range
  • Endpoint: POST /export/users
  • Supports user filtering: No
  • Pagination: No
  • Primary Key: id

All streams support the date_type parameter with timeOfRecording as the default. You can optionally set date_type: processedDate to filter by processing date instead of recording date.

Usage

You can easily run tap-rilla with the included meltano.yml project file.

  1. Create a .env file with your API key:
TAP_RILLA_API_KEY=your_api_key_here
  1. Install Meltano and the tap:
uv tool install meltano
meltano install
  1. Test the tap:
meltano run tap-rilla target-jsonl

Executing the Tap Directly

tap-rilla --version
tap-rilla --help
tap-rilla --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

uv sync

Testing with Meltano

meltano run tap-rilla target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to develop and test this tap.

About

Singer tap for Rilla

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages