How to Access Your Octopart Partner Portal Reports via the Nexar API

Modified on Fri, 4 Oct at 2:02 PM

Prerequisites:

You must have an Octopart Partner Portal account
You must have a Nexar account with an application that has the Design scope available. The Evaluation application will work for this purpose.
You must have at least one report available to download from the Octopart Partner Portal
You must have your company ID available

If you are missing any of these steps, please get in touch with your Business Representative to find out more about Octopart Partner Portal Reports.

Authentication

Please follow the authentication steps found here for Design Applications.

Queries

If you are using an IDE such as Banana Cake Pop, you can use the following two steps to retrieve your reports.

The first query, getReports, accesses the reports you have available in the Octopart Partner Portal:

query getReports {
  datRepReports(
    companyId: "<Your Company ID>"
    where: {createdDate: {gte: "2024-09-01"}}
    order: { createdDate: DESC }
  ){
    nodes {
      title
      id
      createdDate
    }
  }
}

In the response, you will need to copy the reportId of the report you are interested in downloading.

You can then use the following query to receive a download link to your report. This link will expire 1 hour post creation.

query GetReportDownloadUrl {
  datRepDownloadableFile(
    companyId: "<Your Company ID>",
    reportId: "<Your Report ID>") {
    downloadUrl
  }
}

There is also an example in Python and VBA that can be found in our Github.

Note that for the VBA example, you may come across the following pop-ups in Excel:

You will need to Enable Content for the example to work.

You will need to make this file a Trusted Document for the example to work.