Salesforce

What is Insights API?

« Go Back
Information
What is Insights API?
What-is-Insights-API
Details

Leveraging the Insights API, administrators can seamlessly integrate CyberGrants data into their own systems and workflows. This tool provides access to a comprehensive set of standard fields, as well as the flexibility to select up to 10 custom fields for each API endpoint. The data can be delivered in either JSON or CSV format, catering to diverse integration requirements.

Overview of the Insights API Layer Process:

Insights_API_Data_Flow_Diagram.png

See below to learn more about the Insights API layer process.

Step 1: Assess the API Endpoints and Data Fields

The Insights API will include a standard set of fields from across various data tables within CyberGrants. Administrators can also select up to 10 custom fields for each API endpoint.

Step 2: View Available Data Formats

The result files can be delivered in JSON or CSV format. 

Step 3: Understand the Data Refresh Frequency and Costs

The Insights API will contain data that has changed over the last 48 hours. Insights administrators have access to pull from the API as frequently as needed.

  • NOTE: Please keep in mind that the more frequently data is pulled, the higher the metered pass-through cost that will be incurred.

Step 4: Access the Standard Base URLS

You'll receive the base URLs for the Staging and Production environments as part of your Insights API onboarding.

 

What else do you need help with?

Not what you're looking for? Navigate to Understanding Insights API


Powered by