Skip to main content

Akoya
Documentation

Data Providers

The “Data Providers” section displays a list of all affiliate providers live on the Akoya network.

Data Dictionary

The Akoya data dictionary is currently available in an excel file downloadable from the Data Recipient Hub. The dictionary includes current coverage of data elements supported by ten providers and two core providers. See the Data dictionary guide for more information (log into the Hub to view the article). You can also search for the data dictionary guide in the Support Center.

Once you have an app in production, you can download the latest version of the data dictionary by clicking the teal “Download data dictionary” button at the top-right corner of the window. This document is a comprehensive list of data element support by provider and we update it regularly.

Searching and Filtering

Search for a provider by name or provider ID. Results display in the window as you type.

Filter by Product

Clicking on the vertical ellipsis brings up a list of Akoya products to select from an “any” or “all” match drop-down:

  • “Any” returns a list of providers who support at least one of the products selected.

  • “All” returns a list of providers who support all the products you’ve selected.

Export Provider Data

You can export a complete or filtered provider list to CSV or JSON.

CSV Supported Fields

Field

Description

provider_name

Provider display name

provider_id

Unique provider ID

supported_products

Akoya product(s) supported by the provider

provider_url

Provider’s website

logo_url

Provider’s logo URL as displayed in the Hub

icon_url

Provider’s icon URL as displayed in the Hub

JSON Supported Data Elements

Name

Data Type

Description

displayName

String

Provider display name

id

String

Unique provider ID

supportedProducts

Array [String]

Akoya product(s) supported by the provider

providerUrl

String

Provider’s website

logoUrl

String

Provider’s logo URL as displayed in the Hub

iconUrl

String

Provider’s icon URL as displayed in the Hub

Example

These are sample CSV and JSON exports.

CSV
JSON

Provider Info Pages

Clicking on any provider will take you to its info page.

The provider info page is separated into the following tabs:

  • Account types

    • displays a list of all account types and their corresponding accountType enum values (shown in the Hub under the "CODE" column).

  • Data inventory

    • displays a list of data elements supported by that provider.

  • Documentation

    • The “Documentation” tab contains documentation with implementation considerations specific to that provider.

  • Sample users

    • The “Sample Users” tab includes a list of test accounts for use in the sandbox environment. These accounts exist in Akoya's mock provider, Mikomo, and their account data reflects provider nuances with respect to the data elements supported.