Article

Analytics API

« Go Back

Information

 
Full Story

The Analytics API, available in the Poppulo Developer Portal, gives Enterprise Plus users access to raw, people-level communication data. With this API, you can power custom dashboards in tools like Power BI or Tableau, automate data extraction, and refine your communication strategy with precision.

 

Key Capabilities

The Analytics Reporting API supports secure, role-based access to your reporting data.

  • People-Level Data Access
    Retrieve detailed metrics like opens, clicks, likes, and comments tied to individual people data records.

  • Automated Data Extraction
    Trigger and schedule data extracts on your own terms, using API clients and automation tools.

  • Secure, Role-Based Access
    Access is restricted to users with the Enterprise Integrations Manager or Enterprise Administrator role in your account, ensuring the right level of data protection.

  • Flexible Integration
    Use the API directly or connect with platforms like Power BI for seamless reporting workflows.

     

How to Access the API

Step 1: Navigate to the Developer Portal

  1. Log in to your Poppulo account as a user with the Enterprise Integrations Manager or Enterprise Administrator role.

  2. From the Dashboard select Developer Portal.

  3. From here, you can explore documentation, test endpoints, and access API resources.

Step 2: Create an API Client

To automate data pulls or use scheduled jobs:

  1. From the Dashboard select Integrations Manager.

  2. Then select API Clients.

  3. Click Create.

  4. Enter a Name and Description and click Next.

  5. Choose the required permissions (enterprise-level or specific sub-accounts).

  6. Click Save, then Next.

  7. Review the configuration, then click Create.

  8. Copy the generated Client ID and Client Secret.

     

API Structure & Operations

The Analytics API uses GraphQL and follows a secure, asynchronous pattern:

  • Authentication: OAuth 2.0 client credentials

  • Operations:

    • triggerDataExtract: Initiates a data extract job

    • getDataExtract: Polls the job and provides a secure download link once ready

  • Output: Extracted data includes both fact and dimension tables, delivered in CSV format.

For full technical details and code samples, visit the Poppulo Developer Portal.

Was this article helpful?

   

Feedback

Please tell us how we can make this article more useful.

Characters Remaining: 255

 

Contact Support

Don't see what you're looking for?
Contact our support team who will be happy to answer your query.

Contact Us