Introduction

Welcome to the Opally API documentation. The Opally API gives you programmatic access to your company's email, chat, voice, lead, and agent action data — making it easy to build custom dashboards, integrate with BI tools, or power your own reporting UI.

Base URL

https://api.opally.com/v1

All API requests must be made over HTTPS. Requests over plain HTTP will be rejected.

Quick Start

1. Get your API key from the Opally dashboard under Integrations > Developer > API Access

2. Make your first request:

cURL

curl https://api.opally.com/v1/analytics/overview \
  -H "Authorization: Bearer op_live_your_api_key_here"

JavaScript

Python

CLI

1. Explore the endpoints below to fetch analytics, conversation logs, and leads.

CLI

The Opally CLI lets you query the API directly from your terminal — no code required.

npm install -g @opally/cli
opally login op_live_your_api_key_here

opally emails list --limit 5
opally chats messages <id>
opally analytics overview --from 2026-03-01 --to 2026-03-13
opally leads list --source chat --json

All commands support --json for machine-readable output. See the CLI documentation for the full command reference.

What can you build?

• Custom dashboards — Display email, chat, and voice metrics in your own internal tools

• BI integrations — Pull data into Looker, Metabase, or any analytics platform

• Guest communication logs — Show conversation history in your PMS or CRM

• Lead tracking — Pipe captured leads into your sales pipeline

API Overview

Resource	Endpoints	Description
Analytics	GET /v1/analytics/*	Aggregated metrics and time-series data
Conversations	GET /v1/conversations/*	Email logs, chat threads, voice calls
Leads	GET /v1/leads	Captured lead contact information