PgBeam Docs
Analytics

getVercelInstallation

Get Vercel Marketplace installation status

Returns the Vercel Marketplace installation for the organization, including its provisioned resources and their current-period usage. Returns 404 when the organization was not provisioned through the Vercel Marketplace. Powers the dashboard's Vercel integration page.

Usage

const result = await api.analytics.getVercelInstallation({
  pathParams: { org_id: "org_abc123" },
});

Parameters

ParameterTypeRequiredDescription
pathParams.org_idstringYesUnique organization identifier.

Response

Promise<VercelInstallationStatus> — vercel installation status.

Example

import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbk_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.analytics.getVercelInstallation({
  pathParams: { org_id: "org_abc123" },
});

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.
429Rate limited. Try again later.

On this page