Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Amplitude plugin syncs data locally. Use corsair.amplitude.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

Cohorts

Path: amplitude.db.cohorts.search
const rows = await corsair.amplitude.db.cohorts.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
descriptionstringequals, contains, startsWith, endsWith, in
app_idnumberequals, gt, gte, lt, lte, in
publishedbooleanequals
archivedbooleanequals
sizenumberequals, gt, gte, lt, lte, in
last_computednumberequals, gt, gte, lt, lte, in
last_modifiednumberequals, gt, gte, lt, lte, in
is_predefinedbooleanequals
typestringequals, contains, startsWith, endsWith, in
createdAtdateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Events

Path: amplitude.db.events.search
const rows = await corsair.amplitude.db.events.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
event_typestringequals, contains, startsWith, endsWith, in
user_idstringequals, contains, startsWith, endsWith, in
device_idstringequals, contains, startsWith, endsWith, in
timenumberequals, gt, gte, lt, lte, in
app_versionstringequals, contains, startsWith, endsWith, in
platformstringequals, contains, startsWith, endsWith, in
os_namestringequals, contains, startsWith, endsWith, in
os_versionstringequals, contains, startsWith, endsWith, in
device_brandstringequals, contains, startsWith, endsWith, in
device_manufacturerstringequals, contains, startsWith, endsWith, in
device_modelstringequals, contains, startsWith, endsWith, in
carrierstringequals, contains, startsWith, endsWith, in
countrystringequals, contains, startsWith, endsWith, in
regionstringequals, contains, startsWith, endsWith, in
citystringequals, contains, startsWith, endsWith, in
dmastringequals, contains, startsWith, endsWith, in
languagestringequals, contains, startsWith, endsWith, in
ipstringequals, contains, startsWith, endsWith, in
insert_idstringequals, contains, startsWith, endsWith, in
session_idnumberequals, gt, gte, lt, lte, in
createdAtdateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Users

Path: amplitude.db.users.search
const rows = await corsair.amplitude.db.users.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
user_idstringequals, contains, startsWith, endsWith, in
canonical_amplitude_idnumberequals, gt, gte, lt, lte, in
last_seennumberequals, gt, gte, lt, lte, in
is_identifiedbooleanequals
countrystringequals, contains, startsWith, endsWith, in
regionstringequals, contains, startsWith, endsWith, in
citystringequals, contains, startsWith, endsWith, in
languagestringequals, contains, startsWith, endsWith, in
platformstringequals, contains, startsWith, endsWith, in
osstringequals, contains, startsWith, endsWith, in
devicestringequals, contains, startsWith, endsWith, in
createdAtdateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.