# Pivolio Docs ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivolio.com/_mcp/server ## Docs - [Introduction](https://docs.pivolio.com/documentation/get-started/introduction.md): Server-side ad-event tracking with identity resolution and multi-destination delivery. - [How Pivolio works](https://docs.pivolio.com/documentation/get-started/how-pivolio-works.md): What happens to an event between your site and an ad platform. - [Quickstart](https://docs.pivolio.com/documentation/get-started/quickstart.md): From an empty workspace to a delivered conversion. - [Workspaces & write keys](https://docs.pivolio.com/documentation/core-concepts/workspaces-write-keys.md): The unit of isolation, and the credential that lets events into it. - [Events](https://docs.pivolio.com/documentation/core-concepts/events.md): The single event shape every source produces, and the names that mean something. - [Identity resolution](https://docs.pivolio.com/documentation/core-concepts/identity-resolution.md): How scattered events across devices and sessions collapse into one person. - [Destinations vs integrations](https://docs.pivolio.com/documentation/core-concepts/destinations-vs-integrations.md): Two words that sound alike and mean opposite directions. - [Attribution](https://docs.pivolio.com/documentation/core-concepts/attribution.md): How credit for a conversion is divided across the touchpoints that led to it. - [Match quality](https://docs.pivolio.com/documentation/core-concepts/match-quality.md): A 0–100 estimate of how well an ad platform can match your conversions. - [Consent & privacy](https://docs.pivolio.com/documentation/core-concepts/consent-privacy.md): What a visitor's consent state changes, and what leaves your infrastructure. - [Traffic quality](https://docs.pivolio.com/documentation/core-concepts/traffic-quality.md): Scoring events for bot and click-fraud signals before they reach an ad platform. - [Delivery statuses](https://docs.pivolio.com/documentation/core-concepts/delivery-statuses.md): What each delivery outcome means, and which ones you should act on. - [SDKs](https://docs.pivolio.com/documentation/sd-ks/overview.md): Pick the package that matches your framework — they all wrap one engine. - [Browser SDK](https://docs.pivolio.com/documentation/sd-ks/browser.md): The core tracking engine, in vanilla JavaScript and TypeScript. - [React SDK](https://docs.pivolio.com/documentation/sd-ks/react.md): A provider and hooks around the same browser engine. - [Next.js SDK](https://docs.pivolio.com/documentation/sd-ks/next-js.md): The React bindings plus App Router page views. - [Shopify SDK](https://docs.pivolio.com/documentation/sd-ks/shopify.md): A Web Pixel runtime for the storefront funnel. - [Script tag](https://docs.pivolio.com/documentation/sd-ks/script-tag.md): Install from a CDN, with an async command queue and no build step. - [Configuration](https://docs.pivolio.com/documentation/sd-ks/configuration.md): Every SDKConfig field, with its default and its unit. - [Identity and consent](https://docs.pivolio.com/documentation/sd-ks/identity-consent.md): How the SDK stores identity, captures attribution, and honours consent. - [Destinations](https://docs.pivolio.com/documentation/destinations/overview.md): Where Pivolio forwards your conversions, and where it does not. - [Meta](https://docs.pivolio.com/documentation/destinations/meta.md): Send conversions to the Meta Conversions API. - [Google Ads](https://docs.pivolio.com/documentation/destinations/google-ads.md): Send conversions to Google Ads through the Data Manager API. - [TikTok](https://docs.pivolio.com/documentation/destinations/tik-tok.md): Send conversions to the TikTok Events API 2.0. - [Reddit](https://docs.pivolio.com/documentation/destinations/reddit.md): Send conversions to the Reddit Conversions API v3. - [Event mappings](https://docs.pivolio.com/documentation/destinations/event-mappings.md): Decide which Pivolio events become which platform events. - [Consent rules](https://docs.pivolio.com/documentation/destinations/consent-rules.md): Gate each destination on the consent the visitor actually granted. - [Troubleshooting delivery](https://docs.pivolio.com/documentation/destinations/troubleshooting-delivery.md): Read delivery health, and find out why events aren't arriving. - [Integrations](https://docs.pivolio.com/documentation/integrations/overview.md): The inbound sources that feed events into a workspace. - [JavaScript SDK](https://docs.pivolio.com/documentation/integrations/java-script-sdk.md): The browser source — and the only one that sees a click. - [Inbound webhook](https://docs.pivolio.com/documentation/integrations/inbound-webhook.md): POST events to Pivolio from any backend. - [Shopify](https://docs.pivolio.com/documentation/integrations/shopify.md): Forward paid orders from your store as server-side conversions. - [Authentication](https://docs.pivolio.com/documentation/guides/authentication.md): Write keys for ingestion, session cookies for management. - [Connect an AI assistant (MCP)](https://docs.pivolio.com/documentation/guides/mcp.md): Give Claude and other MCP clients read-only access to your workspace. - [Sending events over HTTP](https://docs.pivolio.com/documentation/guides/http-api.md): Ingest events from a server, a CDN worker, or anything that speaks HTTP. - [First-party domains](https://docs.pivolio.com/documentation/guides/first-party-domains.md): Serve the collector from your own subdomain to beat ad-blockers and ITP. - [Team and roles](https://docs.pivolio.com/documentation/guides/team-roles.md): The four account roles and what each one can do. - [Billing](https://docs.pivolio.com/documentation/guides/billing-plans.md): Plans, trials, event allowances, and what a subscription actually buys. - [Errors](https://docs.pivolio.com/documentation/guides/errors.md): One consistent error shape across the whole API. - [Changelog](https://docs.pivolio.com/changelog/llms.txt) ## API Docs - Pivolio [Put Integrations Webhook](https://docs.pivolio.com/api-reference/pivolio/put-integrations-webhook.md) - Pivolio [Get Destinations Meta](https://docs.pivolio.com/api-reference/pivolio/get-destinations-meta.md) - Pivolio [Patch Destinations Meta](https://docs.pivolio.com/api-reference/pivolio/patch-destinations-meta.md) - Pivolio [Patch Members User Id](https://docs.pivolio.com/api-reference/pivolio/patch-members-user-id.md) - Pivolio [Get Invitations](https://docs.pivolio.com/api-reference/pivolio/get-invitations.md) - Pivolio [Post Invitations](https://docs.pivolio.com/api-reference/pivolio/post-invitations.md) - Pivolio [Post Invitations Invitation Id Resend](https://docs.pivolio.com/api-reference/pivolio/post-invitations-invitation-id-resend.md) - Pivolio [Post Invitations Token Accept](https://docs.pivolio.com/api-reference/pivolio/post-invitations-token-accept.md) - Pivolio [Get Invitations Token](https://docs.pivolio.com/api-reference/pivolio/get-invitations-token.md) - Pivolio [Post Ingest Webhook](https://docs.pivolio.com/api-reference/pivolio/post-ingest-webhook.md) - Pivolio [Get Events Event Id](https://docs.pivolio.com/api-reference/pivolio/get-events-event-id.md) - Pivolio [Get Reports Destinations Meta Match Quality](https://docs.pivolio.com/api-reference/pivolio/get-reports-destinations-meta-match-quality.md) - Pivolio [Get Persons Person Id](https://docs.pivolio.com/api-reference/pivolio/get-persons-person-id.md) - Pivolio [Post Destinations Meta Test](https://docs.pivolio.com/api-reference/pivolio/post-destinations-meta-test.md) - Pivolio [Post Notifications Notification Id Seen](https://docs.pivolio.com/api-reference/pivolio/post-notifications-notification-id-seen.md) - Pivolio [Get Persons Person Id Journey](https://docs.pivolio.com/api-reference/pivolio/get-persons-person-id-journey.md) - Pivolio [Get Reports Destinations Meta Delivery](https://docs.pivolio.com/api-reference/pivolio/get-reports-destinations-meta-delivery.md) - Pivolio [Post Workspaces Domains Domain Id Verify](https://docs.pivolio.com/api-reference/pivolio/post-workspaces-domains-domain-id-verify.md) - Pivolio > Event Ingestion [Identify a user](https://docs.pivolio.com/api-reference/pivolio/event-ingestion/issue-identity.md) - Pivolio > Event Ingestion [Track an event](https://docs.pivolio.com/api-reference/pivolio/event-ingestion/track-event.md) - Pivolio > Event Ingestion [Record a consent decision](https://docs.pivolio.com/api-reference/pivolio/event-ingestion/record-consent.md) - Pivolio > Event Ingestion [Pixel fallback](https://docs.pivolio.com/api-reference/pivolio/event-ingestion/ingest-pixel.md) - Pivolio > Event Ingestion [Track a batch of events](https://docs.pivolio.com/api-reference/pivolio/event-ingestion/batch-events.md) - Pivolio > Event Ingestion [Inbound integration event](https://docs.pivolio.com/api-reference/pivolio/event-ingestion/ingest-integration.md) - Pivolio > Authentication [Sign up](https://docs.pivolio.com/api-reference/pivolio/authentication/signup.md) - Pivolio > Authentication [Sign in](https://docs.pivolio.com/api-reference/pivolio/authentication/login.md) - Pivolio > Authentication [Sign out](https://docs.pivolio.com/api-reference/pivolio/authentication/logout.md) - Pivolio > Authentication [Request a password reset](https://docs.pivolio.com/api-reference/pivolio/authentication/forgot-password.md) - Pivolio > Authentication [Reset your password](https://docs.pivolio.com/api-reference/pivolio/authentication/reset-password.md) - Pivolio > Authentication [Change your password](https://docs.pivolio.com/api-reference/pivolio/authentication/change-password.md) - Pivolio > Social Login [Start social login](https://docs.pivolio.com/api-reference/pivolio/social-login/oauth-start.md) - Pivolio > Social Login [Complete social login](https://docs.pivolio.com/api-reference/pivolio/social-login/oauth-callback.md) - Pivolio > Profile [Get your profile](https://docs.pivolio.com/api-reference/pivolio/profile/get-me.md) - Pivolio > Profile [Update your profile](https://docs.pivolio.com/api-reference/pivolio/profile/update-me.md) - Pivolio > Sessions [List active sessions](https://docs.pivolio.com/api-reference/pivolio/sessions/list-sessions.md) - Pivolio > Sessions [Revoke a session](https://docs.pivolio.com/api-reference/pivolio/sessions/revoke-session.md) - Pivolio > Workspaces [List your workspaces](https://docs.pivolio.com/api-reference/pivolio/workspaces/list-workspaces.md) - Pivolio > Workspaces [Create a workspace](https://docs.pivolio.com/api-reference/pivolio/workspaces/create-workspace.md) - Pivolio > Workspaces [Get the active workspace](https://docs.pivolio.com/api-reference/pivolio/workspaces/get-workspace.md) - Pivolio > Workspaces [Delete the active workspace](https://docs.pivolio.com/api-reference/pivolio/workspaces/delete-workspace.md) - Pivolio > Workspaces [Update the active workspace](https://docs.pivolio.com/api-reference/pivolio/workspaces/update-workspace.md) - Pivolio > Workspaces [List members](https://docs.pivolio.com/api-reference/pivolio/workspaces/list-members.md) - Pivolio > Workspaces [Remove a member](https://docs.pivolio.com/api-reference/pivolio/workspaces/remove-member.md) - Pivolio > Workspaces [Update a member's role](https://docs.pivolio.com/api-reference/pivolio/workspaces/update-member.md) - Pivolio > Workspaces [Rotate the write key](https://docs.pivolio.com/api-reference/pivolio/workspaces/rotate-write-key.md) - Pivolio > Workspaces [List write keys](https://docs.pivolio.com/api-reference/pivolio/workspaces/list-write-keys.md) - Pivolio > Workspaces [List destinations](https://docs.pivolio.com/api-reference/pivolio/workspaces/list-destinations.md) - Pivolio > Workspaces [Add a destination](https://docs.pivolio.com/api-reference/pivolio/workspaces/add-destination.md) - Pivolio > Workspaces [Get destination details](https://docs.pivolio.com/api-reference/pivolio/workspaces/get-destination-detail.md) - Pivolio > Workspaces [Delete a destination](https://docs.pivolio.com/api-reference/pivolio/workspaces/delete-destination.md) - Pivolio > Workspaces [Update a destination](https://docs.pivolio.com/api-reference/pivolio/workspaces/update-destination.md) - Pivolio > Workspaces [Test a destination](https://docs.pivolio.com/api-reference/pivolio/workspaces/test-destination.md) - Pivolio > Workspaces [Start Google Ads OAuth](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-oauth-start.md) - Pivolio > Workspaces [Complete Google Ads OAuth](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-oauth-callback.md) - Pivolio > Workspaces [List selectable Google Ads ad accounts](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-accounts.md) - Pivolio > Workspaces [Set the Google Ads account to deliver to](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-select-account.md) - Pivolio > Workspaces [The Google Ads account currently targeted](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-selected-account.md) - Pivolio > Workspaces [Google Ads enhanced-conversions terms status](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-terms-status.md) - Pivolio > Workspaces [List Google Ads conversion actions](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-conversion-actions.md) - Pivolio > Workspaces [Create a Google Ads conversion action](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-create-conversion-action.md) - Pivolio > Workspaces [Set a Google Ads conversion action Primary/Secondary](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-set-action-primary.md) - Pivolio > Workspaces [Remove a Google Ads conversion action](https://docs.pivolio.com/api-reference/pivolio/workspaces/google-remove-action.md) - Pivolio > Domains [List domains](https://docs.pivolio.com/api-reference/pivolio/domains/list-domains.md) - Pivolio > Domains [Add a domain](https://docs.pivolio.com/api-reference/pivolio/domains/add-domain.md) - Pivolio > Domains [Verify a domain](https://docs.pivolio.com/api-reference/pivolio/domains/verify-domain.md) - Pivolio > Domains [Remove a domain](https://docs.pivolio.com/api-reference/pivolio/domains/remove-domain.md) - Pivolio > Reports [Event volume over time](https://docs.pivolio.com/api-reference/pivolio/reports/event-volume.md) - Pivolio > Reports [Overview metrics](https://docs.pivolio.com/api-reference/pivolio/reports/overview.md) - Pivolio > Reports [Event breakdown by name](https://docs.pivolio.com/api-reference/pivolio/reports/event-breakdown.md) - Pivolio > Reports [Delivery status by platform](https://docs.pivolio.com/api-reference/pivolio/reports/delivery-stats.md) - Pivolio > Reports [Destination delivery health](https://docs.pivolio.com/api-reference/pivolio/reports/destination-delivery.md) - Pivolio > Reports [Identity stats](https://docs.pivolio.com/api-reference/pivolio/reports/person-stats.md) - Pivolio > Reports [Top pages](https://docs.pivolio.com/api-reference/pivolio/reports/top-pages.md) - Pivolio > Reports [Top sources](https://docs.pivolio.com/api-reference/pivolio/reports/top-sources.md) - Pivolio > Reports [Match-quality readiness](https://docs.pivolio.com/api-reference/pivolio/reports/destination-match-quality.md) - Pivolio > Reports [Traffic-quality summary](https://docs.pivolio.com/api-reference/pivolio/reports/traffic-quality-report.md) - Pivolio > Attribution [Attribution report](https://docs.pivolio.com/api-reference/pivolio/attribution/report.md) - Pivolio > Attribution [Compare attribution models](https://docs.pivolio.com/api-reference/pivolio/attribution/compare.md) - Pivolio > Attribution [Conversion journeys](https://docs.pivolio.com/api-reference/pivolio/attribution/journeys-report.md) - Pivolio > Attribution [Get attribution config](https://docs.pivolio.com/api-reference/pivolio/attribution/get-attribution-config.md) - Pivolio > Attribution [Update attribution config](https://docs.pivolio.com/api-reference/pivolio/attribution/update-attribution-config.md) - Pivolio > Traffic Quality [Traffic-quality config](https://docs.pivolio.com/api-reference/pivolio/traffic-quality/get-traffic-quality-config.md) - Pivolio > Traffic Quality [Update traffic-quality config](https://docs.pivolio.com/api-reference/pivolio/traffic-quality/update-traffic-quality-config.md) - Pivolio > Events [List events](https://docs.pivolio.com/api-reference/pivolio/events/list-events.md) - Pivolio > Events [Get an event](https://docs.pivolio.com/api-reference/pivolio/events/get-event.md) - Pivolio > Customers [List customers](https://docs.pivolio.com/api-reference/pivolio/customers/list-persons.md) - Pivolio > Customers [Get a customer](https://docs.pivolio.com/api-reference/pivolio/customers/get-person.md) - Pivolio > Customers [Erase a customer](https://docs.pivolio.com/api-reference/pivolio/customers/erase-person.md) - Pivolio > Customers [Override a customer's consent](https://docs.pivolio.com/api-reference/pivolio/customers/override-person-consent.md) - Pivolio > Customers [Get a customer journey](https://docs.pivolio.com/api-reference/pivolio/customers/get-person-journey.md) - Pivolio > Integrations [Get the webhook integration](https://docs.pivolio.com/api-reference/pivolio/integrations/get-webhook-integration.md) - Pivolio > Integrations [Create the webhook integration](https://docs.pivolio.com/api-reference/pivolio/integrations/create-webhook-integration.md) - Pivolio > Integrations [Delete the webhook integration](https://docs.pivolio.com/api-reference/pivolio/integrations/delete-webhook-integration.md) - Pivolio > Integrations [Get the Shopify integration](https://docs.pivolio.com/api-reference/pivolio/integrations/get-shopify-integration.md) - Pivolio > Integrations [Create the Shopify integration](https://docs.pivolio.com/api-reference/pivolio/integrations/create-shopify-integration.md) - Pivolio > Integrations [Delete the Shopify integration](https://docs.pivolio.com/api-reference/pivolio/integrations/delete-shopify-integration.md) - Pivolio > Integrations [Verify a Shopify connection](https://docs.pivolio.com/api-reference/pivolio/integrations/verify-shopify-connection.md) - Pivolio > Realtime [Subscribe to the live stream](https://docs.pivolio.com/api-reference/pivolio/realtime/authorize-realtime.md) - Pivolio > Notifications [List notifications](https://docs.pivolio.com/api-reference/pivolio/notifications/list-notifications.md) - Pivolio > Notifications [Mark all notifications as seen](https://docs.pivolio.com/api-reference/pivolio/notifications/mark-all-seen.md) - Pivolio > Notifications [Mark a notification as seen](https://docs.pivolio.com/api-reference/pivolio/notifications/mark-seen.md) - Pivolio > Billing [Start checkout](https://docs.pivolio.com/api-reference/pivolio/billing/start-checkout.md) - Pivolio > Billing [Open portal](https://docs.pivolio.com/api-reference/pivolio/billing/open-portal.md) - Pivolio > Billing [Change plan](https://docs.pivolio.com/api-reference/pivolio/billing/change-plan.md) - Pivolio > Billing [Cancel a scheduled downgrade](https://docs.pivolio.com/api-reference/pivolio/billing/cancel-scheduled-downgrade.md) - Pivolio > Billing [Cancel at period end](https://docs.pivolio.com/api-reference/pivolio/billing/cancel-subscription.md) - Pivolio > Billing [Undo cancellation](https://docs.pivolio.com/api-reference/pivolio/billing/reactivate-subscription.md) - Pivolio > Billing [List plans](https://docs.pivolio.com/api-reference/pivolio/billing/list-plans.md) - Pivolio > Billing [Plan and usage](https://docs.pivolio.com/api-reference/pivolio/billing/get-usage.md) - Pivolio > Billing [Toggle auto-upgrade](https://docs.pivolio.com/api-reference/pivolio/billing/set-auto-upgrade.md) - Pivolio > Billing [Stripe billing webhook](https://docs.pivolio.com/api-reference/pivolio/billing/stripe-billing-webhook.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.pivolio.com/openapi.json) - [OpenAPI YAML](https://docs.pivolio.com/openapi.yaml)