Retrieve network insights for the provided `access_tokens`

POST /network_insights/report/get

This endpoint allows you to retrieve the Network Insights from a list of access_tokens.

Request Body

Required

NetworkInsightsReportGetRequest defines the request schema for /network_insights/report/get.

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
access_tokens
required, array[string]
A list of access tokens that the Network Insights will be requested for. These correspond to previous Items a user has connected.

Response

NetworkInsightsReportGetResponse defines the response schema for /network_insights/report/get.

Response Properties

report
required, object
Contains data for the Network Insights Report.
report_id
required, string
The unique identifier associated with the Network Insights report object.
generated_time
required, string
The time when the Network Insights Report was generated.
network_attributes
required, object
A map of network attributes, where the key is a string, and the value is a float, int, or boolean.
items
required, array[object]
A list of Items associated with the provided access_tokens.
institution_id
required, string
The ID for the institution the user linked.
institution_name
required, string
The name of the institution the user linked.
item_id
required, string
The identifier for the Item.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.