API - Corsair

Every googleanalytics.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.

Accounts

get

accounts.get Lookup a single Google Analytics account Risk: read

await corsair.googleanalytics.api.accounts.get({});

Input

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

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`displayName`	`string`	No	—
`regionCode`	`string`	No	—
`countryCode`	`string`	No	—
`createTime`	`string`	No	—
`updateTime`	`string`	No	—
`createdAt`	`Date`	No	—

getDataSharingSettings

accounts.getDataSharingSettings Get data sharing settings for an account Risk: read

await corsair.googleanalytics.api.accounts.getDataSharingSettings({});

Input

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

Output: object

Output full type

{
}

list

accounts.list List accounts accessible to the caller [DEPRECATED: use accounts.listV1Beta] Risk: read

await corsair.googleanalytics.api.accounts.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—

Output

Name	Type	Required	Description
`accounts`	`object[]`	No	—
`nextPageToken`	`string`	No	—

accounts full type

{
}[]

listSummaries

accounts.listSummaries List summaries of all accessible accounts and their properties Risk: read

await corsair.googleanalytics.api.accounts.listSummaries({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—

Output

Name	Type	Required	Description
`accountSummaries`	`object[]`	No	—
`nextPageToken`	`string`	No	—

accountSummaries full type

{
}[]

listV1Beta

accounts.listV1Beta List accounts accessible to the caller (v1beta) Risk: read

await corsair.googleanalytics.api.accounts.listV1Beta({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—

Output

Name	Type	Required	Description
`accounts`	`object[]`	No	—
`nextPageToken`	`string`	No	—

accounts full type

{
}[]

provisionAccountTicket

accounts.provisionAccountTicket Request a ticket for creating a Google Analytics account Risk: write

await corsair.googleanalytics.api.accounts.provisionAccountTicket({});

Input

Name	Type	Required	Description
`account`	`any`	No	—
`redirectUri`	`string`	No	—

Output: object

Output full type

{
}

Audience Exports

create

audienceExports.create Create an audience export for later retrieval of users Risk: write

await corsair.googleanalytics.api.audienceExports.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`audienceExport`	`any`	No	—

Output: object

Output full type

{
}

get

audienceExports.get Get metadata about an audience export Risk: read

await corsair.googleanalytics.api.audienceExports.get({});

Input

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

Output: object

Output full type

{
}

list

audienceExports.list List audience exports on a property Risk: read

await corsair.googleanalytics.api.audienceExports.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`audienceExports`	`object[]`	No	—
`nextPageToken`	`string`	No	—

audienceExports full type

{
}[]

query

audienceExports.query Retrieve user rows from an audience export Risk: read

await corsair.googleanalytics.api.audienceExports.query({});

Input

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

Output: object

Output full type

{
}

Audience Lists

create

audienceLists.create Create an audience list for later retrieval of users Risk: write

await corsair.googleanalytics.api.audienceLists.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`audienceList`	`any`	No	—

Output: object

Output full type

{
}

get

audienceLists.get Get metadata about an audience list Risk: read

await corsair.googleanalytics.api.audienceLists.get({});

Input

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

Output: object

Output full type

{
}

list

audienceLists.list List audience lists on a property Risk: read

await corsair.googleanalytics.api.audienceLists.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`audienceLists`	`object[]`	No	—
`nextPageToken`	`string`	No	—

audienceLists full type

{
}[]

query

audienceLists.query Retrieve user rows from an audience list Risk: read

await corsair.googleanalytics.api.audienceLists.query({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`offset`	`number`	No	—
`limit`	`number`	No	—
`returnAllRows`	`boolean`	No	—

Output: object

Output full type

{
}

Audiences

get

audiences.get Lookup a single audience configuration Risk: read

await corsair.googleanalytics.api.audiences.get({});

Input

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

Output: object

Output full type

{
}

list

audiences.list List audiences on a property Risk: read

await corsair.googleanalytics.api.audiences.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`audiences`	`object[]`	No	—
`nextPageToken`	`string`	No	—

audiences full type

{
}[]

Calculated Metrics

list

calculatedMetrics.list List calculated metrics on a property Risk: read

await corsair.googleanalytics.api.calculatedMetrics.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`calculatedMetrics`	`object[]`	No	—
`nextPageToken`	`string`	No	—

calculatedMetrics full type

{
}[]

Channel Groups

list

channelGroups.list List channel groups on a property Risk: read

await corsair.googleanalytics.api.channelGroups.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`channelGroups`	`object[]`	No	—
`nextPageToken`	`string`	No	—

channelGroups full type

{
}[]

Conversion Events

list

conversionEvents.list List conversion events [DEPRECATED: use keyEvents.list] Risk: read

await corsair.googleanalytics.api.conversionEvents.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`conversionEvents`	`object[]`	No	—
`nextPageToken`	`string`	No	—

conversionEvents full type

{
}[]

Custom Dimensions

create

customDimensions.create Create a custom dimension on a property Risk: write

await corsair.googleanalytics.api.customDimensions.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`customDimension`	`any`	No	—

Output: object

Output full type

{
}

get

customDimensions.get Lookup a single custom dimension Risk: read

await corsair.googleanalytics.api.customDimensions.get({});

Input

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

Output: object

Output full type

{
}

list

customDimensions.list List custom dimensions on a property Risk: read

await corsair.googleanalytics.api.customDimensions.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`customDimensions`	`object[]`	No	—
`nextPageToken`	`string`	No	—

customDimensions full type

{
}[]

Custom Metrics

create

customMetrics.create Create a custom metric on a property Risk: write

await corsair.googleanalytics.api.customMetrics.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`customMetric`	`any`	No	—

Output: object

Output full type

{
}

list

customMetrics.list List custom metrics on a property Risk: read

await corsair.googleanalytics.api.customMetrics.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`customMetrics`	`object[]`	No	—
`nextPageToken`	`string`	No	—

customMetrics full type

{
}[]

Data Streams

list

dataStreams.list List data streams on a property Risk: read

await corsair.googleanalytics.api.dataStreams.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`dataStreams`	`object[]`	No	—
`nextPageToken`	`string`	No	—

dataStreams full type

{
}[]

listEventCreateRules

dataStreams.listEventCreateRules List event create rules on a web data stream Risk: read

await corsair.googleanalytics.api.dataStreams.listEventCreateRules({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`eventCreateRules`	`object[]`	No	—
`nextPageToken`	`string`	No	—

eventCreateRules full type

{
}[]

listMeasurementProtocolSecrets

dataStreams.listMeasurementProtocolSecrets List measurement protocol secrets under a data stream Risk: write

await corsair.googleanalytics.api.dataStreams.listMeasurementProtocolSecrets({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`measurementProtocolSecrets`	`object[]`	No	—
`nextPageToken`	`string`	No	—

measurementProtocolSecrets full type

{
}[]

listSKAdNetworkConversionValueSchemas

dataStreams.listSKAdNetworkConversionValueSchemas List SKAdNetwork conversion value schemas on an iOS data stream Risk: read

await corsair.googleanalytics.api.dataStreams.listSKAdNetworkConversionValueSchemas({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`sKAdNetworkConversionValueSchemas`	`object[]`	No	—
`nextPageToken`	`string`	No	—

sKAdNetworkConversionValueSchemas full type

{
}[]

Expanded Data Sets

create

expandedDataSets.create Create an expanded data set on a property Risk: write

await corsair.googleanalytics.api.expandedDataSets.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`expandedDataSet`	`any`	No	—

Output: object

Output full type

{
}

list

expandedDataSets.list List expanded data sets on a property Risk: read

await corsair.googleanalytics.api.expandedDataSets.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`expandedDataSets`	`object[]`	No	—
`nextPageToken`	`string`	No	—

expandedDataSets full type

{
}[]

Key Events

get

keyEvents.get Lookup a single key event (conversion) Risk: read

await corsair.googleanalytics.api.keyEvents.get({});

Input

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

Output: object

Output full type

{
}

list

keyEvents.list List key events on a property Risk: read

await corsair.googleanalytics.api.keyEvents.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`keyEvents`	`object[]`	No	—
`nextPageToken`	`string`	No	—

keyEvents full type

{
}[]

Links

listAdSense

links.listAdSense List AdSense links on a property Risk: read

await corsair.googleanalytics.api.links.listAdSense({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`adSenseLinks`	`object[]`	No	—
`nextPageToken`	`string`	No	—

adSenseLinks full type

{
}[]

listBigQuery

links.listBigQuery List BigQuery links on a property Risk: read

await corsair.googleanalytics.api.links.listBigQuery({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`bigqueryLinks`	`object[]`	No	—
`nextPageToken`	`string`	No	—

bigqueryLinks full type

{
}[]

listDV360Advertiser

links.listDV360Advertiser List Display & Video 360 advertiser links on a property Risk: read

await corsair.googleanalytics.api.links.listDV360Advertiser({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`displayVideo360AdvertiserLinks`	`object[]`	No	—
`nextPageToken`	`string`	No	—

displayVideo360AdvertiserLinks full type

{
}[]

listDV360Proposals

links.listDV360Proposals List Display & Video 360 advertiser link proposals on a property Risk: read

await corsair.googleanalytics.api.links.listDV360Proposals({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`displayVideo360AdvertiserLinkProposals`	`object[]`	No	—
`nextPageToken`	`string`	No	—

displayVideo360AdvertiserLinkProposals full type

{
}[]

listFirebase

links.listFirebase List Firebase links on a property Risk: read

await corsair.googleanalytics.api.links.listFirebase({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`firebaseLinks`	`object[]`	No	—
`nextPageToken`	`string`	No	—

firebaseLinks full type

{
}[]

listGoogleAds

links.listGoogleAds List Google Ads links on a property Risk: read

await corsair.googleanalytics.api.links.listGoogleAds({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`googleAdsLinks`	`object[]`	No	—
`nextPageToken`	`string`	No	—

googleAdsLinks full type

{
}[]

listSearchAds360

links.listSearchAds360 List Search Ads 360 links on a property Risk: read

await corsair.googleanalytics.api.links.listSearchAds360({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`searchAds360Links`	`object[]`	No	—
`nextPageToken`	`string`	No	—

searchAds360Links full type

{
}[]

Measurement Protocol

sendEvents

measurementProtocol.sendEvents Send events to GA4 via the Measurement Protocol. Requires the stream api_secret (not the OAuth token) plus measurementId (web) or firebaseAppId (app) Risk: write

await corsair.googleanalytics.api.measurementProtocol.sendEvents({});

Input

Name	Type	Required	Description
`apiSecret`	`string`	Yes	—
`measurementId`	`string`	No	—
`firebaseAppId`	`string`	No	—
`clientId`	`string`	No	—
`appInstanceId`	`string`	No	—
`userId`	`string`	No	—
`timestampMicros`	`number`	No	—
`userProperties`	`object`	No	—
`consent`	`any`	No	—
`events`	`object[]`	Yes	—

userProperties full type

{
}

events full type

{
  name: string,
  params?: any
}[]

Output: object

Output full type

{
}

validateEvents

measurementProtocol.validateEvents Validate Measurement Protocol events against the debug endpoint before sending. Requires the stream api_secret Risk: read

await corsair.googleanalytics.api.measurementProtocol.validateEvents({});

Input

Name	Type	Required	Description
`apiSecret`	`string`	Yes	—
`measurementId`	`string`	No	—
`firebaseAppId`	`string`	No	—
`clientId`	`string`	No	—
`appInstanceId`	`string`	No	—
`userId`	`string`	No	—
`timestampMicros`	`number`	No	—
`userProperties`	`object`	No	—
`consent`	`any`	No	—
`events`	`object[]`	Yes	—

userProperties full type

{
}

events full type

{
  name: string,
  params?: any
}[]

Output: object

Output full type

{
}

Properties

createRollup

properties.createRollup Create a roll-up property aggregating multiple properties Risk: write

await corsair.googleanalytics.api.properties.createRollup({});

Input

Name	Type	Required	Description
`rollupProperty`	`any`	No	—
`sourceProperties`	`string[]`	No	—

Output: object

Output full type

{
}

get

properties.get Lookup a single GA4 property Risk: read

await corsair.googleanalytics.api.properties.get({});

Input

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

Output

Name	Type	Required	Description
`name`	`string`	No	—
`parent`	`string`	No	—
`displayName`	`string`	No	—
`propertyType`	`string`	No	—
`timeZone`	`string`	No	—
`currencyCode`	`string`	No	—
`industryCategory`	`string`	No	—
`account`	`string`	No	—
`createTime`	`string`	No	—
`updateTime`	`string`	No	—
`createdAt`	`Date`	No	—

getAttributionSettings

properties.getAttributionSettings Get attribution settings for a property Risk: read

await corsair.googleanalytics.api.properties.getAttributionSettings({});

Input

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

Output: object

Output full type

{
}

getDataRetentionSettings

properties.getDataRetentionSettings Get data retention settings for a property Risk: read

await corsair.googleanalytics.api.properties.getDataRetentionSettings({});

Input

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

Output: object

Output full type

{
}

getGoogleSignalsSettings

properties.getGoogleSignalsSettings Get Google Signals settings for a property Risk: read

await corsair.googleanalytics.api.properties.getGoogleSignalsSettings({});

Input

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

Output: object

Output full type

{
}

getPropertyQuotasSnapshot

properties.getPropertyQuotasSnapshot Get a snapshot of property quota usage by category Risk: read

await corsair.googleanalytics.api.properties.getPropertyQuotasSnapshot({});

Input

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

Output: object

Output full type

{
}

list

properties.list List child properties under an account [DEPRECATED: use properties.listFiltered] Risk: read

await corsair.googleanalytics.api.properties.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`filter`	`string`	Yes	—

Output

Name	Type	Required	Description
`properties`	`object[]`	No	—
`nextPageToken`	`string`	No	—

properties full type

{
}[]

listFiltered

properties.listFiltered List GA4 properties matching a filter Risk: read

await corsair.googleanalytics.api.properties.listFiltered({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`filter`	`string`	Yes	—

Output

Name	Type	Required	Description
`properties`	`object[]`	No	—
`nextPageToken`	`string`	No	—

properties full type

{
}[]

update

properties.update Update a GA4 property Risk: write

await corsair.googleanalytics.api.properties.update({});

Input

Name	Type	Required	Description
`property`	`object`	Yes	—
`updateMask`	`string`	No	—

property full type

{
  name: string
}

Output: object

Output full type

{
}

Recurring Audience Lists

create

recurringAudienceLists.create Create a recurring audience list that refreshes daily Risk: write

await corsair.googleanalytics.api.recurringAudienceLists.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`recurringAudienceList`	`any`	No	—

Output: object

Output full type

{
}

get

recurringAudienceLists.get Get metadata about a recurring audience list Risk: read

await corsair.googleanalytics.api.recurringAudienceLists.get({});

Input

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

Output: object

Output full type

{
}

list

recurringAudienceLists.list List recurring audience lists on a property Risk: read

await corsair.googleanalytics.api.recurringAudienceLists.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`recurringAudienceLists`	`object[]`	No	—
`nextPageToken`	`string`	No	—

recurringAudienceLists full type

{
}[]

Reporting Data

listAnnotations

reportingData.listAnnotations List reporting data annotations on a property Risk: read

await corsair.googleanalytics.api.reportingData.listAnnotations({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`reportingDataAnnotations`	`object[]`	No	—
`nextPageToken`	`string`	No	—

reportingDataAnnotations full type

{
}[]

listSubpropertyEventFilters

reportingData.listSubpropertyEventFilters List subproperty event filters on a property Risk: read

await corsair.googleanalytics.api.reportingData.listSubpropertyEventFilters({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`subpropertyEventFilters`	`object[]`	No	—
`nextPageToken`	`string`	No	—

subpropertyEventFilters full type

{
}[]

listSubpropertySyncConfigs

reportingData.listSubpropertySyncConfigs List subproperty sync configs on a property Risk: read

await corsair.googleanalytics.api.reportingData.listSubpropertySyncConfigs({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`subpropertySyncConfigs`	`object[]`	No	—
`nextPageToken`	`string`	No	—

subpropertySyncConfigs full type

{
}[]

Reports

batchRun

reports.batchRun Run multiple reports in a single batch request Risk: read

await corsair.googleanalytics.api.reports.batchRun({});

Input

Name	Type	Required	Description
`property`	`string`	Yes	—
`requests`	`object[]`	No	—

requests full type

{
  dateRanges?: {
    startDate?: string,
    endDate?: string,
    name?: string
  }[],
  dimensions?: {
    name: string,
    dimensionExpression?: any
  }[],
  metrics?: {
    name?: string,
    expression?: string,
    invisible?: boolean
  }[],
  dimensionFilter?: any,
  metricFilter?: any,
  orderBys?: any[],
  limit?: number,
  offset?: number,
  metricAggregations?: string[],
  currencyCode?: string,
  keepEmptyRows?: boolean,
  returnPropertyQuota?: boolean
}[]

Output: object

Output full type

{
}

batchRunPivot

reports.batchRunPivot Run multiple pivot reports in a single batch request Risk: read

await corsair.googleanalytics.api.reports.batchRunPivot({});

Input

Name	Type	Required	Description
`property`	`string`	Yes	—
`requests`	`any[]`	No	—

Output: object

Output full type

{
}

checkCompatibility

reports.checkCompatibility List dimensions and metrics compatible with a report request Risk: read

await corsair.googleanalytics.api.reports.checkCompatibility({});

Input

Name	Type	Required	Description
`property`	`string`	Yes	—
`dateRanges`	`object[]`	No	—
`dimensions`	`object[]`	No	—
`metrics`	`object[]`	No	—
`dimensionFilter`	`any`	No	—
`metricFilter`	`any`	No	—
`offset`	`number`	No	—
`limit`	`number`	No	—
`orderBys`	`any[]`	No	—
`returnPropertyQuota`	`boolean`	No	—

dateRanges full type

{
  startDate?: string,
  endDate?: string,
  name?: string
}[]

dimensions full type

{
  name: string,
  dimensionExpression?: any
}[]

metrics full type

{
  name?: string,
  expression?: string,
  invisible?: boolean
}[]

Output: object

Output full type

{
}

getMetadata

reports.getMetadata Get metadata for available dimensions and metrics. Use apiNames from here in report requests Risk: read

await corsair.googleanalytics.api.reports.getMetadata({});

Input

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

Output: object

Output full type

{
}

run

reports.run Run a customized GA4 report. Derive dimension/metric apiNames from reports.getMetadata Risk: read

await corsair.googleanalytics.api.reports.run({});

Input

Name	Type	Required	Description
`dateRanges`	`object[]`	No	—
`dimensions`	`object[]`	No	—
`metrics`	`object[]`	No	—
`dimensionFilter`	`any`	No	—
`metricFilter`	`any`	No	—
`orderBys`	`any[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`metricAggregations`	`string[]`	No	—
`currencyCode`	`string`	No	—
`keepEmptyRows`	`boolean`	No	—
`returnPropertyQuota`	`boolean`	No	—
`property`	`string`	Yes	—

dateRanges full type

{
  startDate?: string,
  endDate?: string,
  name?: string
}[]

dimensions full type

{
  name: string,
  dimensionExpression?: any
}[]

metrics full type

{
  name?: string,
  expression?: string,
  invisible?: boolean
}[]

Output: object

Output full type

{
}

runFunnel

reports.runFunnel Run a customized funnel report Risk: read

await corsair.googleanalytics.api.reports.runFunnel({});

Input

Name	Type	Required	Description
`property`	`string`	Yes	—
`funnel`	`any`	No	—

Output: object

Output full type

{
}

runPivot

reports.runPivot Run a customized pivot report Risk: read

await corsair.googleanalytics.api.reports.runPivot({});

Input

Name	Type	Required	Description
`property`	`string`	Yes	—
`dateRanges`	`object[]`	No	—
`dimensions`	`object[]`	No	—
`metrics`	`object[]`	No	—
`pivots`	`any[]`	No	—
`dimensionFilter`	`any`	No	—
`metricFilter`	`any`	No	—
`orderBys`	`any[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`returnPropertyQuota`	`boolean`	No	—

dateRanges full type

{
  startDate?: string,
  endDate?: string,
  name?: string
}[]

dimensions full type

{
  name: string,
  dimensionExpression?: any
}[]

metrics full type

{
  name?: string,
  expression?: string,
  invisible?: boolean
}[]

Output: object

Output full type

{
}

runRealtime

reports.runRealtime Run a realtime report (last 30-60 minutes) Risk: read

await corsair.googleanalytics.api.reports.runRealtime({});

Input

Name	Type	Required	Description
`property`	`string`	Yes	—
`dimensions`	`object[]`	No	—
`metrics`	`object[]`	No	—
`dimensionFilter`	`any`	No	—
`metricFilter`	`any`	No	—
`orderBys`	`any[]`	No	—
`limit`	`number`	No	—
`metricAggregations`	`string[]`	No	—
`returnPropertyQuota`	`boolean`	No	—
`minuteRanges`	`any[]`	No	—

dimensions full type

{
  name: string,
  dimensionExpression?: any
}[]

metrics full type

{
  name?: string,
  expression?: string,
  invisible?: boolean
}[]

Output: object

Output full type

{
}

Report Tasks

create

reportTasks.create Create an asynchronous report task Risk: write

await corsair.googleanalytics.api.reportTasks.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`reportTask`	`any`	No	—

Output: object

Output full type

{
}

get

reportTasks.get Get metadata about a report task Risk: read

await corsair.googleanalytics.api.reportTasks.get({});

Input

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

Output: object

Output full type

{
}

list

reportTasks.list List report tasks on a property Risk: read

await corsair.googleanalytics.api.reportTasks.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`showDeleted`	`boolean`	No	—
`parent`	`string`	Yes	—

Output

Name	Type	Required	Description
`reportTasks`	`object[]`	No	—
`nextPageToken`	`string`	No	—

reportTasks full type

{
}[]

query

reportTasks.query Retrieve a report task content (only when ACTIVE) Risk: read

await corsair.googleanalytics.api.reportTasks.query({});

Input

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

Output: object

Output full type

{
}

​Accounts

​get

​getDataSharingSettings

​list

​listSummaries

​listV1Beta

​provisionAccountTicket

​Audience Exports

​create

​get

​list

​query

​Audience Lists

​create

​get

​list

​query

​Audiences

​get

​list

​Calculated Metrics

​list

​Channel Groups

​list

​Conversion Events

​list

​Custom Dimensions

​archive

​create

​get

​list

​Custom Metrics

​create

​list

​Data Streams

​list

​listEventCreateRules

​listMeasurementProtocolSecrets

​listSKAdNetworkConversionValueSchemas

​Expanded Data Sets

​create

​list

​Key Events

​get

​list

​Links

​listAdSense

​listBigQuery

​listDV360Advertiser

​listDV360Proposals

​listFirebase

​listGoogleAds

​listSearchAds360

​Measurement Protocol

​sendEvents

​validateEvents

​Properties

​createRollup

​get

​getAttributionSettings

​getDataRetentionSettings

​getGoogleSignalsSettings

​getPropertyQuotasSnapshot

​list

​listFiltered

​update

​Recurring Audience Lists

​create

​get

​list

​Reporting Data

​listAnnotations

​listSubpropertyEventFilters

​listSubpropertySyncConfigs

​Reports

​batchRun

​batchRunPivot

​checkCompatibility

​getMetadata

​run

Accounts

get

getDataSharingSettings

list

listSummaries

listV1Beta

provisionAccountTicket

Audience Exports

create

get

list

query

Audience Lists

create

get

list

query

Audiences

get

list

Calculated Metrics

list

Channel Groups

list

Conversion Events

list

Custom Dimensions

archive

create

get

list

Custom Metrics

create

list

Data Streams

list

listEventCreateRules

listMeasurementProtocolSecrets

listSKAdNetworkConversionValueSchemas

Expanded Data Sets

create

list

Key Events

get

list

Links

listAdSense

listBigQuery

listDV360Advertiser

listDV360Proposals

listFirebase

listGoogleAds

listSearchAds360

Measurement Protocol

sendEvents

validateEvents

Properties

createRollup

get

getAttributionSettings

getDataRetentionSettings

getGoogleSignalsSettings

getPropertyQuotasSnapshot

list

listFiltered

update

Recurring Audience Lists

create

get

list

Reporting Data

listAnnotations

listSubpropertyEventFilters

listSubpropertySyncConfigs

Reports

batchRun

batchRunPivot

checkCompatibility

getMetadata

run