API

Every amplitude.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Annotations

create

annotations.create Create a new chart annotation on a specific date Risk: write

await corsair.amplitude.api.annotations.create({});

Input

Name	Type	Required	Description
`date`	`string`	Yes	—
`label`	`string`	Yes	—
`details`	`string`	No	—
`app_id`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id: number,
  date: string,
  label: string,
  details?: string,
  app_id?: number
}

list

annotations.list List all chart annotations for the project Risk: read

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

Input

Name	Type	Required	Description
`app_id`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—

data full type

{
  id: number,
  date: string,
  label: string,
  details?: string,
  app_id?: number,
  source?: string
}[]

Charts

get

charts.get Get the data results for a specific chart by ID Risk: read

await corsair.amplitude.api.charts.get({});

Input

Name	Type	Required	Description
`chart_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—
`seriesLabels`	`string[]`	No	—
`title`	`string`	No	—

data full type

{
  series?: {
    type?: string,
    values?: any[]
  }[],
  xValues?: string[]
}

Cohorts

create

cohorts.create Create a new static cohort from a list of user or device IDs Risk: write

await corsair.amplitude.api.cohorts.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`app_id`	`number`	Yes	—
`id_type`	`BY_AMP_ID \| BY_USER_ID \| BY_DEVICE_ID`	Yes	—
`ids`	`string[]`	Yes	—
`owners`	`string[]`	No	—
`description`	`string`	No	—
`published`	`boolean`	No	—

Output

Name	Type	Required	Description
`cohort`	`object`	No	—

cohort full type

{
  id: string,
  name: string,
  size?: number,
  last_computed?: number
}

get

cohorts.get Get details for a specific cohort by ID Risk: read

await corsair.amplitude.api.cohorts.get({});

Input

Name	Type	Required	Description
`cohort_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`cohort`	`object`	No	—

cohort full type

{
  id: string,
  name: string,
  owners?: string[],
  description?: string | null,
  published?: boolean,
  archived?: boolean,
  app_id?: number,
  size?: number,
  last_computed?: number,
  last_modified?: number,
  is_predefined?: boolean,
  type?: string
}

getMembers

cohorts.getMembers Retrieve the member download for a cohort export request Risk: read

await corsair.amplitude.api.cohorts.getMembers({});

Input

Name	Type	Required	Description
`request_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`status`	`string`	No	—
`zip_url`	`string`	No	—

list

cohorts.list List all cohorts in the project Risk: read

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

Input: empty object Output

Name	Type	Required	Description
`cohorts`	`object[]`	No	—

cohorts full type

{
  id: string,
  name: string,
  owners?: string[],
  description?: string | null,
  published?: boolean,
  archived?: boolean,
  app_id?: number,
  size?: number | null,
  last_computed?: number,
  last_modified?: number,
  is_predefined?: boolean,
  type?: string
}[]

Dashboards

get

dashboards.get Get details and chart list for a specific dashboard Risk: read

await corsair.amplitude.api.dashboards.get({});

Input

Name	Type	Required	Description
`dashboard_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`dashboard`	`object`	No	—

dashboard full type

{
  id: number,
  name: string,
  description?: string,
  created?: string,
  lastUpdated?: string,
  createdBy?: string,
  published?: boolean,
  charts?: {
    id: string,
    name?: string
  }[]
}

list

dashboards.list List all dashboards in the project Risk: read

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

Input: empty object Output

Name	Type	Required	Description
`dashboards`	`object[]`	No	—

dashboards full type

{
  id: number,
  name: string,
  description?: string,
  created?: string,
  lastUpdated?: string,
  createdBy?: string,
  published?: boolean
}[]

Events

getList

events.getList List all event types tracked in the project Risk: read

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

Input: empty object Output

Name	Type	Required	Description
`data`	`object[]`	No	—

data full type

{
  event_type?: string,
  display_name?: string,
  totals?: number,
  totals_delta?: number,
  hidden?: boolean,
  deleted?: boolean,
  non_active?: boolean
}[]

identifyUser

events.identifyUser Set or update user properties via the Identify API Risk: write

await corsair.amplitude.api.events.identifyUser({});

Input

Name	Type	Required	Description
`api_key`	`string`	Yes	—
`identification`	`object[]`	Yes	—

identification full type

{
  user_id?: string,
  device_id?: string,
  user_properties: {
  }
}[]

Output

Name	Type	Required	Description
`code`	`number`	Yes	—
`error`	`string`	No	—

upload

events.upload Upload one or more events to Amplitude via HTTP API v2 Risk: write

await corsair.amplitude.api.events.upload({});

Input

Name	Type	Required	Description
`api_key`	`string`	Yes	—
`events`	`object[]`	Yes	—
`options`	`object`	No	—

events full type

{
  event_type: string,
  user_id?: string,
  device_id?: string,
  time?: number,
  event_properties?: {
  },
  user_properties?: {
  },
  app_version?: string,
  platform?: string,
  os_name?: string,
  os_version?: string,
  device_brand?: string,
  device_manufacturer?: string,
  device_model?: string,
  carrier?: string,
  country?: string,
  region?: string,
  city?: string,
  language?: string,
  ip?: string,
  insert_id?: string,
  session_id?: number
}[]

options full type

{
  min_id_length?: number
}

Output

Name	Type	Required	Description
`code`	`number`	Yes	—
`events_ingested`	`number`	No	—
`payload_size_bytes`	`number`	No	—
`server_upload_time`	`number`	No	—

uploadBatch

events.uploadBatch Batch upload events to Amplitude Risk: write

await corsair.amplitude.api.events.uploadBatch({});

Input

Name	Type	Required	Description
`api_key`	`string`	Yes	—
`events`	`object[]`	Yes	—
`options`	`object`	No	—

events full type

{
  event_type: string,
  user_id?: string,
  device_id?: string,
  time?: number,
  event_properties?: {
  },
  user_properties?: {
  },
  app_version?: string,
  platform?: string,
  os_name?: string,
  os_version?: string,
  device_brand?: string,
  device_manufacturer?: string,
  device_model?: string,
  carrier?: string,
  country?: string,
  region?: string,
  city?: string,
  language?: string,
  ip?: string,
  insert_id?: string,
  session_id?: number
}[]

options full type

{
  min_id_length?: number
}

Output

Name	Type	Required	Description
`code`	`number`	Yes	—
`events_ingested`	`number`	No	—
`payload_size_bytes`	`number`	No	—
`server_upload_time`	`number`	No	—

Exports

getData

exports.getData Export raw event data for a given time range as a zip archive Risk: read

await corsair.amplitude.api.exports.getData({});

Input

Name	Type	Required	Description
`start`	`string`	Yes	—
`end`	`string`	Yes	—

Output

Name	Type	Required	Description
`status`	`string`	No	—
`url`	`string`	No	—

Users

getActivity

users.getActivity Get recent event activity for a specific user Risk: read

await corsair.amplitude.api.users.getActivity({});

Input

Name	Type	Required	Description
`user`	`number`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`events`	`object[]`	No	—
`userData`	`object`	No	—

events full type

{
  event_type?: string,
  event_time?: string,
  event_properties?: {
  },
  session_id?: number,
  amplitude_id?: number
}[]

userData full type

{
  num_events?: number,
  num_sessions?: number,
  first_used?: string,
  last_used?: string,
  canonical_amplitude_id?: number
}

getProfile

users.getProfile Get the profile and properties for a specific user Risk: read

await corsair.amplitude.api.users.getProfile({});

Input

Name	Type	Required	Description
`user_id`	`string`	No	—
`amplitude_id`	`number`	No	—

Output

Name	Type	Required	Description
`userData`	`object`	No	—

userData full type

{
  user_id?: string,
  amplitude_id?: number,
  canonical_amplitude_id?: number,
  merged_amplitude_ids?: number[],
  is_identified?: boolean,
  user_properties?: {
  },
  country?: string,
  region?: string,
  city?: string,
  language?: string,
  platform?: string,
  os?: string,
  device?: string,
  last_seen?: number
}

search

users.search Search for users by user ID or device ID Risk: read

await corsair.amplitude.api.users.search({});

Input

Name	Type	Required	Description
`user`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`matches`	`object[]`	No	—
`next`	`string`	No	—

matches full type

{
  amplitude_id: number,
  user_id?: string,
  last_seen?: number,
  is_identified?: boolean,
  country?: string,
  city?: string,
  platform?: string,
  os?: string,
  device?: string
}[]

Overview

Plugins

Annotations

create

list

Charts

get

Cohorts

create

get

getMembers

list

Dashboards

get

list

Events

getList

identifyUser

upload

uploadBatch

Exports

getData

Users

getActivity

getProfile

search

Overview

Plugins

​Annotations

​create

​list

​Charts

​get

​Cohorts

​create

​get

​getMembers

​list

​Dashboards

​get

​list

​Events

​getList

​identifyUser

​upload

​uploadBatch

​Exports

​getData

​Users

​getActivity

​getProfile

​search

Annotations

create

list

Charts

get

Cohorts

create

get

getMembers

list

Dashboards

get

list

Events

getList

identifyUser

upload

uploadBatch

Exports

getData

Users

getActivity

getProfile

search