Pendo.io

Pendo.io Data Sync API

The Data Sync API from Pendo.io — 3 operation(s) for data sync.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/authentication/pendoio-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/openapi/pendoio-data-sync-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/errors/pendoio-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/data-model/pendoio-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/pendoio/refs/heads/main/conventions/pendoio-conventions.yml

OpenAPI Specification

pendoio-data-sync-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Pendo Engage Account Data Sync API
  description: Pendo's Engage API provides programmatic access to product analytics and in-app guide data collected by the Pendo agent. It includes resource endpoints for pages, features, track events, guides, visitors, accounts, segments, reports, and metadata, plus a powerful Aggregation API that runs MongoDB-like structured queries over collected events. Authentication uses a per-subscription integration key passed in the x-pendo-integration-key header.
  version: v1
  contact:
    name: Pendo Developers
    url: https://developers.pendo.io/
  x-source: https://engageapi.pendo.io/ (public Postman collection 16265887/Tzm6jvKG)
servers:
- url: https://app.pendo.io
  description: US (default)
- url: https://us1.app.pendo.io
  description: US1
- url: https://app.eu.pendo.io
  description: EU
- url: https://app.au.pendo.io
  description: AU/APAC
- url: https://app.jpn.pendo.io
  description: Japan
security:
- IntegrationKey: []
tags:
- name: Data Sync
paths:
  /api/v1/datasync/storageTypes/gcs/destinations/Default/credentials:
    put:
      operationId: rotateCredentialsForGcsDestination
      summary: Rotate Credentials for GCS Destination
      tags:
      - Data Sync
      requestBody:
        content:
          application/json:
            example:
              serviceAccount: service-account@test-env.iam.gserviceaccount.com
              secretKey: <secretKey>
      responses:
        '200':
          description: Successful response
  /api/v1/datasync/storageTypes/s3/destinations/Default/credentials:
    put:
      operationId: rotateCredentialsForS3Destination
      summary: Rotate Credentials for S3 Destination
      tags:
      - Data Sync
      requestBody:
        content:
          application/json:
            example:
              accessKeyId: AKIAkjvafvafd
              secretAccessKey: <secretAccessKey>
      responses:
        '200':
          description: Successful response
  /api/v1/datasync/storageTypes/azure/destinations/Default/credentials:
    put:
      operationId: rotateCredentialsForAzureDestination
      summary: Rotate Credentials for Azure Destination
      tags:
      - Data Sync
      requestBody:
        content:
          application/json:
            example:
              clientId: 0b501e7e-feed-da1e-iced-c0ffee000000
              clientSecret: <clientSecret>
      responses:
        '200':
          description: Successful response
components:
  securitySchemes:
    IntegrationKey:
      type: apiKey
      in: header
      name: x-pendo-integration-key
      description: Pendo integration key, created at https://app.pendo.io/admin/integrationkeys