Quick Answer
Pinnacle Series reporting data is refreshed in the backend approximately every 15 to 30 minutes, so Reporting API refresh schedules should be designed around business value, data type, and reporting requirements rather than refreshing all endpoints at high frequency.
What This Article Helps With
This article explains how to choose refresh schedules when external systems retrieve data from the Pinnacle Series Reporting API, including Microsoft Power BI and other BI platforms. It covers the difference between static and transactional data, incremental refresh, and the limits that affect refresh planning.
This article is most relevant to:
- API integration teams
- BI and reporting teams
- Power BI developers
- Reporting Administrators
- Enterprise IT teams
Reporting Refresh Frequency
Reporting refresh frequency is how often an external system retrieves data from the Pinnacle Series APIs. Different datasets can use different refresh schedules depending on operational needs. For example:
- User activity data: daily or multiple times per day
- Content metadata: weekly or monthly
- Historical reporting datasets: controlled scheduled refreshes
Static Data vs Transactional Data
Static or reference data changes relatively infrequently. Examples include:
- content metadata
- Learning Paths
- Library structures
- categories
- tags
Transactional data changes more frequently and is typically tied to user activity. Examples include:
- Assignment progress
- completions
- searches
- logins
- resource access
Separating static datasets and transactional datasets into different refresh schedules can significantly improve reporting efficiency.
Incremental Refresh
Incremental refresh is a reporting strategy that retrieves only newly changed or recently updated records instead of refreshing the entire dataset each time. Platforms such as Microsoft Power BI commonly use incremental refresh to improve refresh performance and reduce processing overhead.
How to Choose a Reporting Refresh Schedule
Organizations typically determine refresh frequency based on:
- number of users
- reporting complexity
- dashboard usage
- operational reporting requirements
- dataset size
- API endpoint type
Not all Reporting API endpoints require the same refresh cadence. Content structures and learning metadata usually change less often than user engagement or Assignment activity, and refreshing large reference datasets unnecessarily can increase refresh times and add avoidable load in downstream reporting systems.
For larger datasets and enterprise reporting environments, we recommend:
- using controlled refresh schedules
- separating high-change datasets from low-change datasets
- refreshing only data that delivers operational value
- using incremental extraction strategies where possible
- avoiding unnecessary full historical refreshes
Limits and Constraints
- Pinnacle Series refreshes reporting data in the backend approximately every 15 to 30 minutes, so data retrieved from the Reporting API reflects the most recent backend refresh rather than real-time activity.
- We recommend scheduling external refreshes no more often than every 15 to 30 minutes for any dataset, because the documented backend refresh cadence is approximately 15 to 30 minutes.
- Refresh frequency recommendations may vary depending on dataset size and customer reporting requirements.
- Some reporting environments may experience long refresh durations if large historical datasets are refreshed too frequently.
- Refreshing all endpoints at very high frequency is generally not recommended unless there is a specific operational requirement.
- API consumers are responsible for designing appropriate refresh and caching strategies within their BI or integration platform.
- Some reporting tools, including Power BI, may have their own dataset refresh limitations or gateway constraints.
Common Questions
How often does Pinnacle Series refresh reporting data?
Pinnacle Series refreshes reporting data in the backend approximately every 15 to 30 minutes.
How often should I refresh Pinnacle Series reporting data?
Refresh frequency should align to business value and operational need rather than refreshing all endpoints continuously. User activity datasets are commonly refreshed more often than content metadata datasets, and no external refresh needs to run more often than the approximately 15 to 30 minute backend refresh cadence.
Should all Reporting API endpoints refresh at the same frequency?
No. Different datasets change at different rates. Separating static reference data from high-activity transactional data is considered best practice.
Can large datasets be refreshed multiple times per day?
Potentially, yes. Evaluate the dataset size, reporting requirements, and downstream BI platform performance before choosing the schedule.
Does Pinnacle Series require real-time reporting refreshes?
No. Most reporting scenarios use scheduled refresh strategies aligned to operational reporting needs, and Pinnacle Series reporting data is refreshed in the backend approximately every 15 to 30 minutes.
Related Pinnacle Series API Articles
- Pinnacle Series API Reporting Guide
- Exploring a Pinnacle Series Integration
- Pinnacle Series Reporting API Data Dictionary