User Guide Española
Admin GuidesVersionsAiimi
  • Introducing Aiimi Insight Engine
    • Española Release
    • Versions
  • Search
    • Searching for Information
      • Advanced Searches
      • Search Focus
      • 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
    • Search Results
      • Lenses and Result Views
        • Map Lens
        • Timeline Lens
        • 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
      • Why These Results
        • Find Searched Terms
        • Why My Search Matched
      • Related Results
      • Watermarking
    • Item Classification
      • Editing a Classification
    • AI Helper
    • 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
      • Import Items to a Collection
      • Sharing a Collection
      • Adding Comments to a Collection
      • Redacting Collection Information
      • Exporting a Collection
  • Subject Access Request
    • Subject Access Requests
    • Create or Receive Data Requests
      • Create a Request From The Portal
      • Assigning a Request
      • Create a Manual Request
      • Create and Manage Data Subject Types
    • Finding a Request
    • Items for a Request
      • Redacting Sensitive Information
      • Getting Items Reviewed
    • Completing a Request
    • Assigning Users to a SAR
    • Message the Requestor
    • Internal Messaging
  • Profile
    • Profile Pictures
  • 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