GuidesAPI ReferenceDiscussions
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

Use the API to build your own Reports

Suggest Edits

Overview

The following sections will show you how to export reporting related information using the Blend Public API.

The Blend Reporting API gives you programmatic access to end-of-day reporting data on activity within Blend for your internal and external users on the platform. The API allows you to integrate with this data store in your preferred warehousing destination but also can serve data to existing BI or Analytics tools already leveraged by your organization.

It will allow your organization to better measure Blend's performance. This API serves as an alternative to Blend's deprecated Daily Analytics Package and is a single, easy-to-use and scalable set of endpoints to obtain the data relevant to the loans in Blend's platform.

For further details, please refer to the 'Blend API Reporting' schema reference.

Note - the data in the most current stable version of the Reporting API is also available for authorized users to download as a CSV directly from the Blend Workspace. Please see the Help Center on how to access the Reporting Dashboard.

❗️

Only Production Data Available

Please note that the reporting API functions in only Blend's production environment

🚧

Data is Delayed 3Hrs

Please note that Data from the Reporting API is on a three-hour delay

Endpoints

Please see the Reporting API Schema Reference, or the Data Dictionary for all fields and definitions available in each route.

📘

Reporting Routes

To preface, all interactions for reporting must start with the path /reporting. Then, depending on the desired endpoint, you'll want to specify the reporting information you want.

Example full URL:

https://api.blendlabs.com/reporting/nps

GET /documents

Retrieve documents uploaded to Blend on each loan by whom and at what time.

GET /loans

Retrieve a list of loans along with loan meta data, timestamps for certain milestones, as well as specific application information (application source, borrower econsent, etc.)

GET /nps

Retrieve the NPS scores and associated comments for Blend loans

GET /activities

Provides data on borrower activity. Can be used to derive a funnel for where borrowers drop off in application.

GET /lenders

Retrieve lender users of Blend, what roles they hold within the organization, and metrics around loan activity.

GET /borrowers

Retrieve borrowers users within Blend, the loan they are associated with, and both their invited and activation times

GET /lender-pab-activities

Retrieve event data around PAB activities including credit pull and DU recommendation, as well as information on who completed the action (borrower, lender, system).

GET /follow-ups

Retrieve data around all Follow-Ups created within Blend, with additional information on who requested the Follow-Up, and timestamps such as created, requested, completed, and cancelled.

GET /data-verification-usage

Provides weekly aggregate metrics for data verification features such as asset connectivity and The Work Number.

Example request

Request for obtaining NPS scores:

curl -X GET \
 https://api.beta.blendlabs.com/reporting/nps \
 -H 'Authorization: {{YOUR AUTH TOKEN}}' \
 -H 'X-Blend-Deployment: {{YOUR BLEND DEPLOYMENT}}' \
 -H 'cache-control: no-cache'

Response from the above request:

{
 "nps": [
    {
      "loanId": "62492b43-7d38-4ffd-8c09-b9e00c7ed42a",
      "score": "9",
      "comment": "Great!",
      "datetime": "2018-10-23T20:18:53.764Z"
    },
    {
      "loanId": "5d968480-dd8a-4d61-9d0f-44b595df510d",
      "score": "10",
      "comment": null,
      "datetime": "2018-10-25T00:31:42.937Z"
    },
    {
      "loanId": "a7ff799d-393a-4ebb-b26e-594d4180b6fc",
      "score": "8",
      "comment": "Julian was great!!",
      "datetime": "2018-10-26T19:06:51.311Z"
    },
    {
      "loanId": "399cdc10-5b8c-4efb-a1ab-b3b338c7092a",
      "score": "8",
      "comment": "Pretty convenient.",
      "datetime": "2018-10-23T18:18:42.148Z"
   }
 ],
 "prevCursor": "0",
 "nextCursor": "0"
}

Resources

Updated over 2 years ago