Amplitude API Endpoints

The Amplitude plugin provides access to Amplitude's analytics APIs for event tracking, user management, cohorts, charts, dashboards, annotations, and data exports.

New to Corsair? Learn about core concepts like API access, authentication, and error handling.

Full Implementation: For the complete, up-to-date list, see the Amplitude plugin source code.

Events

upload

events.upload

Upload one or more events to Amplitude via HTTP API v2.

await corsair.amplitude.api.events.upload({
    events: [{ 
        event_type: "page_view",
        user_id: "user-123",
    }],
});

uploadBatch

events.uploadBatch

Batch upload events to Amplitude.

await corsair.amplitude.api.events.uploadBatch({
    events: [{ 
        event_type: "purchase",
        user_id: "user-123",
        event_properties: { amount: 49.99 },
    }],
});

identifyUser

events.identifyUser

Set or update user properties via the Identify API.

await corsair.amplitude.api.events.identifyUser({
    user_id: "user-123", 
    user_properties: {
        plan: "pro",
        country: "US",
    },
});

getList

events.getList

List all event types tracked in the project.

const events = await corsair.amplitude.api.events.getList({});

Users

search

users.search

Search for users by user ID or device ID.

const results = await corsair.amplitude.api.users.search({
    user_id: "user-123", 
});

getProfile

users.getProfile

Get the profile and properties for a specific user.

const profile = await corsair.amplitude.api.users.getProfile({
    user_id: "user-123", 
});

getActivity

users.getActivity

Get recent event activity for a specific user.

const activity = await corsair.amplitude.api.users.getActivity({
    user_id: "user-123", 
    limit: 50,
});

Cohorts

list

cohorts.list

List all cohorts in the project.

const cohorts = await corsair.amplitude.api.cohorts.list({});

get

cohorts.get

Get details for a specific cohort by ID.

const cohort = await corsair.amplitude.api.cohorts.get({
    cohort_id: "cohort-id", 
});

create

cohorts.create

Create a new static cohort from a list of user or device IDs.

const cohort = await corsair.amplitude.api.cohorts.create({
    name: "Power Users", 
    app_id: 12345,
    id_type: "BY_USER_ID",
    ids: ["user-1", "user-2", "user-3"],
});

Parameters:

Name	Type	Required	Description
`name`	`string`	Yes	Cohort name
`app_id`	`number`	Yes	Amplitude app ID
`id_type`	`string`	Yes	`BY_USER_ID` or `BY_DEVICE_ID`
`ids`	`string[]`	Yes	List of user or device IDs

getMembers

cohorts.getMembers

Retrieve the member list for a cohort export request.

const members = await corsair.amplitude.api.cohorts.getMembers({
    cohort_id: "cohort-id", 
});

Charts

get

charts.get

Get the data results for a specific chart by ID.

const chart = await corsair.amplitude.api.charts.get({
    chart_id: "chart-id", 
});

Dashboards

list

dashboards.list

List all dashboards in the project.

const dashboards = await corsair.amplitude.api.dashboards.list({});

get

dashboards.get

Get details and chart list for a specific dashboard.

const dashboard = await corsair.amplitude.api.dashboards.get({
    dashboard_id: "dashboard-id", 
});

Annotations

list

annotations.list

List all chart annotations for the project.

const annotations = await corsair.amplitude.api.annotations.list({});

create

annotations.create

Create a new chart annotation on a specific date.

const annotation = await corsair.amplitude.api.annotations.create({
    date: "2024-01-15", 
    label: "Product launch",
    description: "Launched v2.0",
});

Parameters:

Name	Type	Required	Description
`date`	`string`	Yes	Date for the annotation (YYYY-MM-DD)
`label`	`string`	Yes	Short annotation label
`description`	`string`	No	Longer annotation description

Exports

getData

exports.getData

Export raw event data for a given time range as a zip archive.

const exportData = await corsair.amplitude.api.exports.getData({
    start: "20240101T00", 
    end: "20240102T00",
});

Parameters:

Name	Type	Required	Description
`start`	`string`	Yes	Start datetime (YYYYMMDDThh format)
`end`	`string`	Yes	End datetime (YYYYMMDDThh format)

Amplitude API Endpoints

On this page