Metadata-Version: 2.4
Name: airbyte-agent-amplitude
Version: 0.1.10
Summary: Airbyte Amplitude Connector for AI platforms
Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
Project-URL: Repository, https://github.com/airbytehq/airbyte-agent-connectors
Project-URL: Issues, https://github.com/airbytehq/airbyte-agent-connectors/issues
Author-email: Airbyte <contact@airbyte.io>
License: Elastic-2.0
Keywords: agent,ai,airbyte,amplitude,api,connector,data-integration,llm,mcp
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.13
Requires-Dist: httpx>=0.24.0
Requires-Dist: jinja2>=3.0.0
Requires-Dist: jsonpath-ng>=1.6.1
Requires-Dist: jsonref>=1.1.0
Requires-Dist: opentelemetry-api>=1.37.0
Requires-Dist: opentelemetry-sdk>=1.37.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: segment-analytics-python>=2.2.0
Description-Content-Type: text/markdown

# Amplitude

The Amplitude agent connector is a Python package that equips AI agents to interact with Amplitude through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the Amplitude Analytics API. Provides access to core analytics data including event exports, cohort definitions, chart annotations, event type listings, active user counts, and average session length metrics. Authentication uses HTTP Basic with your Amplitude API key and secret key.


## Example questions

The Amplitude connector is optimized to handle prompts like these.

- List all chart annotations in Amplitude
- Show me all cohorts
- List all event types
- Which cohorts have more than 1000 users?
- What are the most popular event types by total count?
- Show me annotations created in the last month

## Unsupported questions

The Amplitude connector isn't currently able to handle prompts like these.

- Create a new annotation
- Delete a cohort
- Export raw event data

## Installation

```bash
uv pip install airbyte-agent-amplitude
```

## Usage

Connectors can run in open source or hosted mode.

### Open source

In open source mode, you provide API credentials directly to the connector.

```python
from airbyte_agent_amplitude import AmplitudeConnector
from airbyte_agent_amplitude.models import AmplitudeAuthConfig

connector = AmplitudeConnector(
    auth_config=AmplitudeAuthConfig(
        api_key="<Your Amplitude project API key. Find it in Settings > Projects in your Amplitude account.
>",
        secret_key="<Your Amplitude project secret key. Find it in Settings > Projects in your Amplitude account.
>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})
```

### Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. 
If your Airbyte client can access multiple organizations, also set `organization_id`.

This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).

```python
from airbyte_agent_amplitude import AmplitudeConnector, AirbyteAuthConfig

connector = AmplitudeConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})
```

## Full documentation

### Entities and actions

This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).

| Entity | Actions |
|--------|---------|
| Annotations | [List](./REFERENCE.md#annotations-list), [Get](./REFERENCE.md#annotations-get), [Search](./REFERENCE.md#annotations-search) |
| Cohorts | [List](./REFERENCE.md#cohorts-list), [Get](./REFERENCE.md#cohorts-get), [Search](./REFERENCE.md#cohorts-search) |
| Events List | [List](./REFERENCE.md#events-list-list), [Search](./REFERENCE.md#events-list-search) |
| Active Users | [List](./REFERENCE.md#active-users-list), [Search](./REFERENCE.md#active-users-search) |
| Average Session Length | [List](./REFERENCE.md#average-session-length-list), [Search](./REFERENCE.md#average-session-length-search) |


### Authentication

For all authentication options, see the connector's [authentication documentation](AUTH.md).

### Amplitude API docs

See the official [Amplitude API reference](https://www.docs.developers.amplitude.com/analytics/apis/).

## Version information

- **Package version:** 0.1.10
- **Connector version:** 1.0.2
- **Generated with Connector SDK commit SHA:** 20f00dda69661bd8f1fe16371d553e41a819e109
- **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/amplitude/CHANGELOG.md)