User Guide Release Primo
Admin GuidesAiimiVersions
  • Introducing Aiimi Insight Engine
    • Primo Release
    • Versions
  • Search
    • Introduction
    • Searching for Information
      • Ways to Search
      • Avanced Searches
      • Folder Browsing
      • Saved Searches
        • Saving a Search Query
        • Accessing Saved Searches
        • Bulk Search
          • Use Cases
          • Create a Bulk Search
            • Search Details
            • Map Fields
            • Review Search
            • Notifications
          • Bulk Search Template
      • Multilingual Search
    • Search Results
      • Lenses and Result Views
        • Timeline
        • Relationship
          • Finding Result Connections
          • Minimum Results
          • Relationship Type
          • Accessible Relationship Map
        • Related Result Connections
          • Understand Connections
          • Adding card details
          • Explore More Connections
      • Filtering Results
        • Using Minimum Matching Terms
        • Using Synonyms
      • Sorting Results
      • Quick Actions
        • Document Preview
        • Mark As Useful
        • Mark As Sensitive
      • Why These Results
        • Find Searched Terms
        • Why My Search Matched
      • Subject Matter Experts
    • Item Previews
      • Inline Preview
      • Full Screen Preview
  • Collections
    • What is a Collection?
      • Collection Types
    • Manage collections
      • Create a Collection
      • Status Management
      • Edit, Delete or Merge
    • Using a Collection
      • Add Items to a Collection
      • Sharing a Collection
      • Adding Comments to a Collection
  • Subject Access Request
    • Introduction
    • Creating or Receiving New SARs
      • Requests From The Portal
        • Creating a SAR from the Portal
        • Assigning a Request
      • Create a Manual Response
        • Searches
        • Subject
        • Collection Settings
        • Privacy Portal
      • Create and Manage Data Subject Types
    • Data for a SAR
      • Finding Information for a SAR
        • Payment Card Information (PCI)
        • Personally Identifiable Information (PII)
        • Redacting Sensitive Information
      • Messaging a SAR Requestor
      • Internal SAR Messaging
    • Completing a SAR
      • Finding a SAR
      • Getting Data Reviewed
        • Assigning Users to a SAR
      • Exporting a SAR Response
      • Disclosing to the Portal
  • Help and Support
    • Leaving Feedback
    • Accessibility Statement for Aiimi Insight Engine
  • Advanced Applications
    • Metrics
    • Manage Collection Type
      • Create a Collection Type
    • Using The Manage Chart
    • OData API
      • Set Access
      • Aggregating Results
      • Query Parameters
Powered by GitBook
On this page
  1. Advanced Applications
  2. OData API

Set Access

Within your 3rd party analytics tool you need to create an OData query. You need to select OData Feed as your source type.

The API URL and user credentials must be entered at the beginning to authenticate access.

  1. Enter the OData API Endpoint URL from your administrator.

    • Contact your Aiimi Insight Engine administrator to get this from the control hub.

apiUrl/odata/entitySetName
  1. Using query parameters enter your Aiimi Insight Engine username and API key to start the query.

    • Contact your Aiimi Insight Engine administrator to get this information.

?username=usernamehere
?api-key=apikeyhere

Example Structure:

apiUrl/odata/entitySetName?username=username&api-key=apikey&

PreviousOData APINextAggregating Results