API-Based Approaches to Match Reporting Workspace Outcome
This page provides examples and guidance for API users on how to retrieve, analyze, and work with data from Pure using the Pure API (and optionally the web service). The focus is on recreating insights similar to those available in Pure Reporting example workspaces, using API endpoints combined with post-processing logic — offering a complementary approach for scenarios where external analysis, automation, or integration is needed, while the built-in reporting engine in Pure Admin continues to serve customer reporting needs effectively.
The goal is to help users uncover key research insights by accessing raw and structured data through API endpoints. Although some aggregate metrics (e.g., totals, averages, rankings) are not directly provided, they can be derived by applying custom post-processing logic using tools such as Excel, Python, or BI platforms. This approach empowers users to transform and adapt Pure data to support broader analytical or reporting & integration objectives.
Access to certain sensitive or internal data may require elevated API permissions or administrative credentials, depending on your configuration admin access.
📊 Research Metrics Accessible via API (Current Examples)
These examples demonstrate how to extract specific research-related insights—such as metrics, collaboration patterns, and output counts—using the API. More examples will be added over time to cover a broader range of data types and use cases.
| Metric Title | Description | API Endpoints Used | Comparable Pure Reporting Workspace |
|---|---|---|---|
| Pure API Guide: Total Number of Research Outputs per Gender | Count of outputs grouped by gender of authors |
|
Number of Research Output per gender |
| Pure API Guide: h-Indexes | h-index per person based on linked outputs and metrics |
|
h-indexes (Report example) |
| Pure API Guide: Total Number of Citations per Person | Sum of citation counts for each person |
|
Total number of citations per person |
| Pure API Guide: Collaboration Map from the Pure Portal | External orgs connected to projects/Research outputs, for visual collaboration |
|
Collaboration map from Pure Portal |
| Pure API Guide: Total Number of Projects with International Collaborating Partners | Projects that include external orgs from different countries |
|
N/A
|
✅ Data Validation
All examples listed above have been run and validated against the corresponding reporting workspaces in Pure. The figures retrieved through the API match those shown in the reports, confirming that the API can accurately reproduce these key metrics for internal or external reporting use.