Status for the API can be found at https://status.pendo.io/
\nRelease notes for new stable web SDK versions are published at https://web-sdk.pendo.io/versions. Updates are promoted to stable on Thusdays with hotfixes and beta releases pushing more frequently.
\nIf you're looking for how to install Pendo into your application, how Pendo collects visitor and account analytics from your application, or how you can retrieve or extract those analytics data from Pendo for external consumption, Pendo provides the following APIs and integration kits for customers:
\nThe Pendo Web SDK API allows developers to programmatically interact with Pendo's Web SDK, the JavaScript client that collects user interactions and displays in-app messaging.
\nThe Feedback API is available in a separate Postman collection.
\nThe Pendo Resource Center Integration Kit provides an integration framework that allows third party developers to create applications that Pendo customers can activate and provide to their users.
\nThe Pendo Tech Corner offers an introduction to Pendo's API here: https://academy.pendo.io/api-setup
\nThe easiest way to start using the Pendo API is by clicking the Run in Postman button at the top of the collection. Postman is a free tool which helps developers run and debug API requests, and is the source of truth for this documentation. Every endpoint you see documented here is readily available by running our Postman collection.
\nYou must have a Pendo integration key from your Pendo subscription to use this collection. Access to this API is dependent on your level of service with Pendo. Check with your Pendo admin at your company or a Pendo representative if you don't know if you have API access.
\nIntegration keys are created in Pendo Settings > Integrations. Please visit this help center page for more information. When enabled for the subscription, admins can create and manage those keys here.
\nIntegration keys should be kept secret! It is how you securely access and update information about your users and accounts in Pendo. Do not share them in client-side javascript, publicly accessible code repositories, etc.
\nTo create an Integration Key:
\nLogin to the Pendo Application as an Admin user.
\nVisit the Integrations section in the Pendo App, and then click on Integration Keys.
\nClick on the Add Integration Key button at the top right-hand side of the screen.
\nGive your new key an appropriate description.
\nIf a read-write key is needed, tick the box marked Allow Write Access.
\nClick on Create to finish.
\nSecurely capture and store your new key outside of Pendo.
\nIntegration keys are only displayed at the time of creation and aren't listed in the UI. We can't recover a lost integration key. If you're unable to find the value for an existing key, you must create a new key. Pendo doesn't limit the number of keys generated.
\nThe Engage API collection is built to propagate the API key down to all requests when it is added to the Authorization tab for the collection.
\nSelect the Pendo API collection.
\nOpen the Authorization tab.
\nAdd your integration key to the Value field.
\nAll other fields are preconfigured.
\nType = API Key
\nKey = x-pendo-integration-key
\nAdd to = Header
\nAll folders and requests are set to inherit auth from their parent and adding the integration key to the collection automatically pushes the integration key to the request header for all requests.
\nThe main URL used to access the Pendo API corresponds to the region and web address that you use when logging into Pendo's UI. Those URLs are:
\nhttps://app.pendo.io
https://app.eu.pendo.io
https://us1.app.pendo.io
https://app.jpn.pendo.io
https://app.au.pendo.io
All endpoints in this collection are configured to use a variable, baseUrl, to represent these. This collection is defaulted to https://app.pendo.io. If you log into Pendo using one of the other domains, please follow these steps to update the collection with the relevant base URL for your subscription.
Select the Pendo API collection.
\nOpen the Variables tab.
\nAdd your baseURL to the Current Value field.
\nClick Save.
\nMany GET methods in the Pendo API are functional without any additional variables or configuration changes. Try GET Return List of All Pages or GET Return List of All Features to see a request without any additional changes.
Targeted requests for individual objects need an ID. The ID is returned in the list of all objects using the API. This ID is also available in the page URL when viewing the object in Pendo for most objects. For example, when viewing guide details in Pendo the URL path is:
\napp.pendo.io/s/[subscriptionId]/guides/[guideId]
Add IDs to the Value column in the Params tab in the request. The Key is already filled in.
\nWelcome to Pendo's API documentation. This is a RESTful API used to query, update, and reset Pendo data primarily by running Aggregation queries or modifying Guide resources.
\nOnce installed the Pendo snippet in your application, visitor activity is collected automatically by the Pendo agent and sent via Image Beacons to Pendo for data processing. Pendo accepts these events immediately but ingests and processes visitor data asynchronously. Events sent by the agent are not immediately available via the API but they are usually available within 15 minutes of receipt.
\nThe Pendo API allows developers to
\nrequest and modify resources like guides, visitor metadata, and reports
\ncreate track events to record events not associated with simple browser events
\nuse powerful aggregation queries to retrieve and transform your visitor data
\nPendo's Aggregation API allows you to request structured transformations of the events collected by the agent using a MongoDB-like query language. It supports arbitrary grouping, filtering, and projections, as well as selecting and merging object-specific analytics for pages, features, track events, and guides. Many of the charts, graphs, and reports provided in the Pendo interface are generated by the sources and operations provided.
\nNote: All request and response bodies, including errors, are encoded in JSON.
\nWe use conventional HTTP response codes to indicate the success or failure of an API request. The various HTTP status codes we might return are listed below, but in general, consider the following:
\n2xx range indicates success
\n4xx range indicates an error that failed given the information provided (e.g., a required parameter was omitted, a resource was not able to be found or updated, etc.)
\n5xx range indicates an error on the server side. These calls should be retried within a reasonable timeframe. We recommend one second or more.
\nReturns full list of pages
\n","auth":{"type":"apikey","apikey":{"value":"The pageId referenced below can be found at the end of the URL when viewing details for a specific page within the app. You can view your list of available pages here.
pageId
\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[{"id":"6b42300b-a3b9-41f5-8f0d-b63c7c94698c","name":"Return a Specific Page","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Comma-separated pageIds
\n","type":"text/plain"},"key":"id","value":"pageId1,pageId2,[...]"}],"variable":[]}},"response":[{"id":"4746406d-e25e-4838-8901-3f2698b4c901","name":"Return List of Specific Pages","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"The featureId referenced below can be found at the end of the URL when viewing details for a specific feature within the app. You can view a comprehensive list of all tagged features here.
featureId
\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[{"id":"1ef46bad-f5dd-4bcb-a3ed-907e90d00e1a","name":"Return a Specific Feature","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Comma-separated featureIds
\n","type":"text/plain"},"key":"id","value":"featureId1,featureId2,[...]"}],"variable":[]}},"response":[{"id":"e8d4e2a4-afd3-4dfc-8748-6d872c004aff","name":"Return List of Specific Features","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"The track endpoint allows you record any actions your users perform, along with any properties that describe the action. Each action is known as an event. Each event has a name and properties.
\nNote: YourPendo_trackEventSecret_Keyis different from your x-pendo-integration-key or your Pendo Subscription API Key (which is embedded in your install snippet). To find your Pendo_trackEventSecret_Key, navigate to your Subscription Settings and choose your app. Under the \"App Details,\" click on \"Show\" next to \"Track Event Shared Secret.\"
** Note that the timestamp should be the current time whenever possible. An event with a timestamp in the past will not be processed with the regular hourly processing and will only appear in the UI after Pendo's daily and weekly event reprocessing. Events with timestamps greater than 7 days may not be processed.
\n","urlObject":{"protocol":"https","path":["data","track"],"host":["data","pendo","io"],"query":[],"variable":[]}},"response":[{"id":"d3284c3f-2213-4dcd-a79e-7fb04b1a03c2","name":"Send a Track Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Returns full list of track events
\n","auth":{"type":"apikey","apikey":{"value":"The trackTypeId referenced below can be found at the end of the URL when viewing details for a specific track event within the app. You can view your list of available track events here.
trackTypeId
\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[{"id":"ab62be62-ebcc-4fa6-8f53-741a97b9f167","name":"Return a Specific Track Type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-pendo-integration-key","value":"Gets a visitor object using a Visitor ID.
\n","auth":{"type":"apikey","apikey":{"value":"Visitor ID
\n","type":"text/plain"},"type":"any","value":null,"key":"visitorId"}]}},"response":[{"id":"48edccd5-e9b4-4ce7-8fda-fed092d67557","name":"Get Visitor by ID","originalRequest":{"method":"GET","header":[{"key":"content-type","value":"application/json"},{"key":"x-pendo-integration-key","value":"You may also retrieve visitor information by using a base64-encoded Visitor ID.
\n","auth":{"type":"apikey","apikey":{"value":"\"b64_\" + your encoded ID
\n","type":"text/plain"},"type":"any","value":"","key":"b64_id"}]}},"response":[{"id":"7e2a400a-65a7-4433-8266-f6a7f07a37a7","name":"Get Visitor by base64 encoded ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Returns a summary of visitor activity for a 24 hour time period. For specific event counts, use the aggregation endpoint and queries below.
\nNote****__: Visitor history is limited to the last 180 days.
\nEach historical event is a JSON object, each with its own type-dependent fields.
\n","auth":{"type":"apikey","apikey":{"value":"Start time for historical data, in milliseconds since the epoch
\n","type":"text/plain"},"key":"starttime","value":""}],"variable":[{"description":{"content":"Visitor ID
\n","type":"text/plain"},"type":"any","value":null,"key":"visitorId"}]}},"response":[{"id":"8ca5c67d-bea4-4b84-a374-ff566a8f35f5","name":"Get Visitor History for a Time Period","originalRequest":{"method":"GET","header":[{"key":"content-type","value":"application/x-www-form-urlencoded"},{"key":"x-pendo-integration-key","value":"The visitor endpoint allows you to retrieve visitor specific details by supplying a visitor ID as part of your request. The visitorId referenced below can be found on the visitors list page or at the end of the url when viewing a visitor details page.
Gets an account object using an Account ID.
\n","auth":{"type":"apikey","apikey":{"value":"Account ID
\n","type":"text/plain"},"type":"any","value":null,"key":"accountId"}]}},"response":[{"id":"fa2bf1bf-86cd-444d-a8e8-4fd6cf2fa16e","name":"Get Account by ID","originalRequest":{"method":"GET","header":[{"key":"content-type","value":"application/json"},{"key":"x-pendo-integration-key","value":"You may also retrieve account information by using a base64-encoded Account ID.
\n","auth":{"type":"apikey","apikey":{"value":"base64 encoded Account ID
\n","type":"text/plain"},"type":"any","value":null,"key":"b64_id"}]}},"response":[{"id":"9f156d73-3c6e-4ea1-b3f4-2df6dcb543c5","name":"Get Account by base64 encoded ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"The account endpoint allows you to retrieve account-specific details by supplying an account ID as part of your request. The accountId referenced below can be found on the accounts list page or at the end of the url when viewing an account details page.
Returns a list of all bulk deletion requests not yet completed.
\n","auth":{"type":"apikey","apikey":{"value":"Returns information on a specific bulk deletion request. These are available even after a deletion is complete.Every bulk delete request and its completion status is preserved for all time and serves as a receipt of the request and a record of its completion.
\n","auth":{"type":"apikey","apikey":{"value":"Id of the deletion request
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"a40b1653-fc49-46f0-899a-deaf4aa5ca39","name":"Get one bulk deletion status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"The bulk deletion endpoint allows large numbers of visitors and accounts to be deleted at once. Each request can schedule deletion for up to 500 visitors or accounts. The request enters those IDs into a queue for later deletion which may take up to 21 days. During the deletion process, all visitors or accounts are also marked as Do Not Process (DNP) so no further data will be collected.
\nMultiple API calls may result in a single deletion request id as individual requests are consolidated a maximum of 500 visitors or accounts. Requests to delete items whose deletion has already been requested, but has not yet started, will fail with a BadRequest response.
Note that deletions apply to all areas of Pendo, including Adopt and Feedback.
\n","_postman_id":"1f49623d-e7cd-49d0-b9dd-c49b5b2eae84","auth":{"type":"apikey","apikey":{"value":"You may also retrieve a single segment's details by including its segmentId. This can be found at the end of the URL when viewing details for a specific segment within the Pendo UI.
Segment ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"876f4bb4-8499-41e9-8718-56b4949b0267","name":"Get Segment by segmentId","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Start an asynchronous export of the visitors in a Segment.
\n","auth":{"type":"apikey","apikey":{"value":"Segment ID
\n","type":"text/plain"},"type":"any","value":"","key":"segmentId"}]}},"response":[{"id":"23fd42c7-39ed-498f-bccf-3b7c5cae87d2","name":"Start export of segment visitors","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Retrieve the status of a segment export. The jobId is returned in the response of the \"Start export of segment visitors\" request above.
Segment ID
\n","type":"text/plain"},"type":"any","value":"","key":"segmentId"},{"id":"ffc70650-1db9-4305-88fe-375b26030e9d","description":{"content":"Job ID (from POST request)
\n","type":"text/plain"},"type":"any","value":"","key":"jobId"}]}},"response":[{"id":"d7358d3e-2852-49bc-b7a0-2b07cbdde976","name":"Check segment export status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-base64-encoded-params","value":"true"}],"url":{"raw":"https://app.pendo.io/api/v1/segment/:segmentId/visitors/:jobId/status","host":["https://app.pendo.io"],"path":["api","v1","segment",":segmentId","visitors",":jobId","status"],"variable":[{"key":"segmentId","value":"UImDiWIPtuGM6eP48XzrWHYrz50","description":"Segment ID"},{"key":"jobId","value":"103021d1-9358-4602-9a6c-2fc618b74a4c","description":"Job ID (from POST request)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"\"completed\""}],"_postman_id":"0da75965-ad54-4a55-bade-1b180115f72d"},{"name":"Retrieve segment export results","id":"b4362d4f-1e3f-404d-9884-30d5c97245bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Get the segment export results in CSV format once it has completed processing.
\n","auth":{"type":"apikey","apikey":{"value":"Segment ID
\n","type":"text/plain"},"type":"any","value":"","key":"segmentId"},{"id":"7e0f9af8-8ae7-46fe-bd11-c3fbe4a9ab63","description":{"content":"Job ID (from POST request)
\n","type":"text/plain"},"type":"any","value":"","key":"jobId"},{"id":"51a627bf-9f25-423d-8026-ced43394f29b","description":{"content":"File type. Currently only supports csv
\n","type":"text/plain"},"type":"any","value":"csv","key":"contentType"}]}},"response":[{"id":"a3222184-b1ad-4209-b38b-9d58d64e0ade","name":"Retrieve segment export results","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Create a segment from a list of visitors. This action supports up to 10 million visitor IDs.
\nSegments are created instantly but adding visitors to the segment is done via an asynchronous job. Segments process one at a time (per subscription).
\n","auth":{"type":"apikey","apikey":{"value":"Get the status of a segment. The segment status will be available for up to 4 hours after processing completes.
\nUpdate the name or visitor list for an existing segment. This can only be done for segments created via the API.
\nAt least one value is required. Any value provided will overwrite the previous value.
\nSegments are created instantly but adding visitors to the segment is done via an asynchronous job. Segments process one at a time (per subscription).
\n","auth":{"type":"apikey","apikey":{"value":"Delete an existing segment.
\n","auth":{"type":"apikey","apikey":{"value":"Add a single visitor to a segment. This can only be done for segments created via the API.
\n","auth":{"type":"apikey","apikey":{"value":"Segment ID
\n","type":"text/plain"},"type":"any","value":"","key":"segmentId"},{"id":"899c7ae5-f1d5-4b2f-a448-6867b05e630f","description":{"content":"Visitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"visitorId"}]}},"response":[{"id":"999ac02b-7f8b-424d-8b76-6789f9bf3e40","name":"Add a visitor to a segment","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Delete a single visitor from a segment. This can only be done for segments created via the API.
\n","auth":{"type":"apikey","apikey":{"value":"Segment ID
\n","type":"text/plain"},"type":"any","value":"","key":"segmentId"},{"id":"82397f69-eb7c-46ff-b218-ba66814c89a6","description":{"content":"Visitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"visitorId"}]}},"response":[{"id":"22f86216-6d73-4c95-9162-b4ed7ec5d7da","name":"Remove a visitor from a segment","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Add or remove a small batch of visitors in a segment. This can only be done for segments created via the API.
\nLimits for this endpoint are:
\n10 operations max per patch call
\n1000 visitors max per patch call
\nSegment ID
\n","type":"text/plain"},"type":"any","value":"","key":"segmentId"}]}},"response":[{"id":"48683ff7-740e-4c13-840c-e002d5fc00fb","name":"Add/remove small batches of visitors to a segment","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"The segment endpoint allows you to retrieve visitor specific details by supplying a visitor ID as part of your request. The segmentId referenced below can be found at the end of the url when viewing a segment in the Pendo UI.
Returns an array of JSON objects representing all public reports for a subscription.
\n","auth":{"type":"apikey","apikey":{"value":"Returns a list of JSON objects. Paths, Funnels, and Data Explore reports cannot be returned with this endpoint.
\n","auth":{"type":"apikey","apikey":{"value":"ID of the report
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"f0ff706f-29ea-4a3b-b75e-971333fdbb1d","name":"Return Report Contents as Array of JSON Objects","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Returns a .csv of the report contents. Paths, Funnels, and Data Explore reports cannot be returned with this endpoint.
\n","auth":{"type":"apikey","apikey":{"value":"ID of the report
\n","type":"text/plain"},"type":"any","value":"","key":"reportId"}]}},"response":[{"id":"a570b30a-5721-4b63-ba8d-e81f7ae9d9f9","name":"Return Report Contents as CSV","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"text/csv"},{"key":"x-pendo-integration-key","value":"The reports API works with Visitor or Account reports that have been created in your subscription. The :reportId referenced below can be found at the end of the URL when viewing a report within the app. Visitor and Account reports can managed from the Visitor or Account report tabs.
NOTE: While Paths, Funnels, and Data Explorer reports will be returned in the list of reports, their contents are not available via the two \"Return Report Contents\" requests.
\nReturns a JSON list of all guides for a subscription. For multi-app subscriptions, specify the application in the query parameters.
\n","auth":{"type":"apikey","apikey":{"value":"Instead of returning all guides, you can specify a singular guide you'd like returned by adding a guideId to the request. Comma separated values are allowed. For example, if you wanted to return multiple guides but not the entire list, follow the format: guide?id=guideId_1,guideId_2,guideId_3
guideID
\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[{"id":"775cf4e0-5553-45ba-a06b-6a308e9a8012","name":"Return a Specific Guide","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Returns a JSON list of all versions of a guide, from current to oldest. Changes to guides through the Pendo user interface often result in multiple individual updates, each of which will be independently reflected in the history.
\n","auth":{"type":"apikey","apikey":{"value":"Reset the guide seen records for a guide with ID guideId for a particular visitor with ID visitorId. The guide can be in any state.
Note: The visitor should immediately be able to see the guide again. However, the previous records may not be reflected in the UI for some time.
\n","auth":{"type":"apikey","apikey":{"value":"ID of the guide to be reset
\n","type":"text/plain"},"type":"any","value":"","key":"guideId"},{"description":{"content":"ID of the visitor whose record of having seen the guide should be removed
\n","type":"text/plain"},"type":"any","value":"","key":"visitorId"}]}},"response":[{"id":"9441f774-fd73-44bb-aeb1-98a46b0f853b","name":"Reset Guide Seen for Specific Visitor","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Reset the guide seen records for a particular visitor with ID {visitorId}. All seen data will be removed across all guides for that visitor.
ID of the visitor whose record of having seen all guides should be removed
\n","type":"text/plain"},"type":"any","value":"","key":"visitorId"}]}},"response":[{"id":"f6d79847-8bb2-48c3-85df-8ed3b86ed250","name":"Reset Guide Seen for Specific Visitor for All Guides","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Reset an individual staged guide with ID guideId. All visitors that have seen the guide previously will be eligible to see it again as if it were a newly created guide. All previous guide data will be deleted for this guide, including any poll response data, though this may take some time to be reflected in the UI.
guideId to be reset of all views
\n","type":"text/plain"},"type":"any","value":"","key":"guideId"}]}},"response":[{"id":"b3541285-8802-4c00-99f0-96425b646675","name":"Reset Individual Staged Guide","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Reset ALL staged guides. All visitors that have seen guides previously will be eligible to them again as if they were newly created guides. All previous guide data will be deleted, including any poll response data, though this may take some time to be reflected in the UI.
\n","auth":{"type":"apikey","apikey":{"value":"Export all experiment results for a single guide. The response will be returned as a .csv.
\n","auth":{"type":"apikey","apikey":{"value":"ID of the guide
\n","type":"text/plain"},"type":"any","value":"","key":"guideId"}]}},"response":[{"id":"7fe674a5-52ab-4034-bba4-9d82076c085e","name":"Export Guide Experiment Results","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-pendo-integration-key","value":"Export XLIFF XML for up to 15 guides per request. Guides are selected by guideId. Response contains XML with each guide XLIFF contained in a file tag.
\nImport up to 15 XLIFF 1.2 files per request. Each file is one guideId/target language combination, delineated by ... contained in the parent .... Import validates each file and will continue to the next file if an import fails.
https://app.pendo.io/api/v1/guide\n\nThe guideId referenced below can be found at the end of the URL when viewing an individual guide details page. You can access that page by going to the guides list and then clicking into any guide.
Gets the metadata schema for a single kind of metadata (visitor or account).
\n","auth":{"type":"apikey","apikey":{"value":"\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":null,"key":"kind"}]}},"response":[{"id":"b1cbe9b1-d46c-4be1-8f64-78d26af2ad2f","name":"Get a Metadata Schema","originalRequest":{"method":"GET","header":[{"key":"content-type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Gets the value of metadata field for an individual account or visitor
\n","auth":{"type":"apikey","apikey":{"value":"\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"","key":"kind"},{"description":{"content":"type of metadata field by origin (agent, custom, salesforce, etc.)
\n","type":"text/plain"},"type":"any","value":"","key":"group"},{"description":{"content":"ID of the visitor or account being updated
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"name of the metadata field
\n","type":"text/plain"},"type":"any","value":"","key":"fieldName"}]}},"response":[{"id":"c88b95b2-2496-4dca-9dea-20f1492dbd20","name":"Get Value of a Metadata Field","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"This provides an opt-out capability for visitors and accounts to prevent them from receiving guides. To use this feature, contact support to enable the setting \"Enable guide exclude list per visitor and account\". Without this setting, attempts to set blacklistguides metadata will fail.
\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"","key":"kind"},{"description":{"content":"ID of the visitor or account to update
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0d34efb9-722d-40bc-a2b3-374307805865","name":"Opt-out a Visitor or Account From All Guide Display","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-key-integration","value":"Use this flag to opt-out a visitors from all Pendo analytics and Guides. This flag is typically used to help companies align to GDPR requirements where a user can invoke their data right(s).
\nLearn more about GDPR at Pendo.
\nIf you select \"do not process\" for a visitor, the agent will recognize that it's a \"do not process\" visitor on the first hit of a visitor and immediately discard the data. For subsequent visits, Pendo already knows the visitor is DNP and does not even collect any data. For agent versions lower than 2.15.6, Pendo will immediately discard the data.
\nNote: Data for \"Do Not Process\" Visitors is unrecoverable, regardless of agent version.
\n","auth":{"type":"apikey","apikey":{"value":"\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"","key":"kind"},{"description":{"content":"ID of the visitor to update
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5f834222-005e-4bef-a860-aa750a4b339e","name":"Opt-Out or Do Not Process a Visitor or Account","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Sets the value of an agent or custom metadata field on a single account or visitor. When setting custom metadata fields, a new field will be created if the provided name does not match an existing custom field. When creating fields in this manner, please go to the Data Mappings page to set the data type.
\n","auth":{"type":"apikey","apikey":{"value":"\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"","key":"kind"},{"description":{"content":"type of metadata field by origin (agent, custom, salesforce, etc.)
\n","type":"text/plain"},"type":"any","value":"","key":"group"},{"description":{"content":"ID of the visitor or account being updated
\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"name of the metadata field being updated
\n","type":"text/plain"},"type":"any","value":"","key":"fieldName"}]}},"response":[{"id":"6a26b61a-da93-404a-a1aa-1746e4b5a24e","name":"Set Value for an Agent or Custom Field","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Sets the value of multiple metadata fields on set of accounts or visitors. When setting custom metadata fields, a new field will be created if the provided name does not match an existing custom field. When creating fields in this manner, please go to the Data Mappings page to set the data type.
\nAny number of records may be submitted for update, but the call is limited to five (5) minutes. Any calls that takes longer will timeout with a 408 Request Timeout.
\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"","key":"kind"},{"description":{"content":"type of metadata field by origin (agent, custom, salesforce, etc.)
\n","type":"text/plain"},"type":"any","value":"","key":"group"}]}},"response":[{"id":"3714aa24-3e2a-4a7c-92ea-9dd6e8b97c14","name":"Set Value for a Set of Agent or Custom Fields","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-pendo-integration-key","value":"Creates or undeletes up to 24 agent or custom metadata fields. When undeleting, any data for that field that was in Pendo prior to its deletion will be restored within a few hours. However, any values associated with a data scrub or received for the field(s) while it was deleted will not appear.
\n","auth":{"type":"apikey","apikey":{"value":"\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"visitor","key":"kind"},{"id":"1fcd21e6-2474-46f8-9bcd-5bfdcdc14f59","description":{"content":"\"agent\" or \"custom\"
\n","type":"text/plain"},"type":"any","value":"custom","key":"group"}]}},"response":[{"id":"25115fd2-0b2f-490c-8aed-19d487cb5b26","name":"Create or undelete an Agent or Custom Field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Deletes an exisiting metadata field.
\n","auth":{"type":"apikey","apikey":{"value":"\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"visitor","key":"kind"},{"id":"67a76fc8-e57c-4cde-aaec-14c4f13f0d3c","description":{"content":"\"agent\" or \"custom\"
\n","type":"text/plain"},"type":"any","value":"custom","key":"group"},{"id":"2d1af099-3fb3-42e9-9ccc-85921c30391e","description":{"content":"metadata field name
\n","type":"text/plain"},"type":"any","value":"","key":"field"}]}},"response":[{"id":"c892f286-74fd-4e30-adf9-beec050f4aab","name":"Delete an Agent or Custom Field","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"Returns objects that all metadata fields are tied to. This includes:
\nReturns objects that a metadata field is tied to. This includes:
\n\"visitor\" or \"account\"
\n","type":"text/plain"},"type":"any","value":"","key":"kind"},{"id":"7063e8bb-4a90-43dd-83e7-85f65ffe36a1","description":{"content":"type of metadata field by origin (agent, custom, salesforce, etc.)
\n","type":"text/plain"},"type":"any","value":"","key":"group"},{"id":"91cfcdfe-faf9-423f-8712-5f0b05505256","description":{"content":"name of the metadata field being updated
\n","type":"text/plain"},"type":"any","value":"","key":"fieldName"}]}},"response":[{"id":"f6f43d38-5dc6-42a9-b3fe-48d160ce83cb","name":"Get a List of Dependencies for a Metadata Field","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-pendo-integration-key","value":"When attempting to update Date fields, please be sure to only use accepted formats. Sending unaccepted date format data into a date field can have unexpected consequences for any data entries or edits. By default, the date format in Settings > Data Mappings is ISO8601 W3C format. To change this default to a different format, please contact Support.
1136232245 (s)1136232245426 (ms)Mon Jan 02 2006Mon Jan 02 2006 15:04:05 MST-070001/02/2006 03:04pmISO8601 W3C, ex: 2006-01-02T115:04:05.999-05:002006-01-02T15:04:05-07002006-01-02T15:04:05-07:002006-01-02T15:04:05.999-07:002006-01-02T15:04:05Z07:002006-01-02T15:04:05.99Z2006-01-02T15:04:052006-01-02 15:04:05 -07002006-01-02 15:04:05 MST2006-01-02 15:04:05Returns all items on the exclude list.
\nNote: If you have converted the Server Host/Domain list in the Pendo platform to an Include List, any server returned by this endpoint will have its events included in analytics and all others will not.
\n","auth":{"type":"apikey","apikey":{"value":"Return all excluded items of a specific type
\n","auth":{"type":"apikey","apikey":{"value":"Gets all server names recorded by Pendo over the life of the subscription.
\n","auth":{"type":"apikey","apikey":{"value":"Returns a single server by name.
\n","auth":{"type":"apikey","apikey":{"value":"Returns a list of all excluded (blacklisted) or staging servers.
\n","auth":{"type":"apikey","apikey":{"value":"The Exclude List is a set of rules that determine what data to exclude from surfacing in analytics. Excluded data is still collected; it just won't appear by default in analytics: dashboards, reports, etc.. This is often used to exclude internal or testing data from your main analytics numbers.
\nExclude lists are made up of patterns that match against data collected from your apps. These patterns use simplified wildcard logic (called glob patterns), such as:
\n*dev* → excludes any string that contains \"dev\"
\nstaging_ → excludes any string starting with \"staging_\"
\n*@company.com → excludes any string ending with \"@company.com\"
\n