Getting started with the reporting API
Oracle Eloqua's reporting API allows you to access data directly from the Insight data warehouse. The reporting API is built using Open Data Protocol (OData), a REST-based open web protocol for sharing data in a standardized form for easy consumption. OData is different from other REST-based web services in that it provides a uniform way to describe both the data and the data model. Eloqua's reporting API is recommended for use when you want to retrieve reporting data directly from the Insight data warehouse.
Considerations
To use the reporting API, you will need to ensure that you have an Eloqua instance and that your user has an account on this instance. Additionally, the user will need to be assigned the analyzer license. This ensures that customers have precise control over access permissions to the reporting API.
Some Eloqua instances enable contact-level security, which restricts access to data based on different user roles. For example, users might only have access to contacts located in their geographical region. Because these permissions affect what data the user can access, it is important that the Eloqua user accessing the API has the appropriate permissions. Learn more.
API Call Format
The reporting API call consists of an initial authentication and the following API call format. The reporting API only supports GET commands.
GET [baseURL]/API/odata/[subjectArea]/[APIVersionIdentifier]/[endpoint]
Limits
The reporting API has a maximum limit of returning 10,000 records per page. Utilize the $top parameter to specify the number of records returned and implement pagination for larger datasets. By default, the reporting API will return a maximum of 25 months of historical data, unless otherwise specified.
Request soft limit: 1,000 per hour.
Processing limits are influenced by various factors. If operations remain within these specified limits and adhere to best practices, the impact of volume alone is expected to be minimal. We continuously log and monitor the number of API requests executed to uphold stability and reliability.