Contents

(+ show- hide)

The Product Sentiment Insights API workflow begins with a request for a manifest file list. Values in the list will be in the form of URL paths which will be used in the next step.

Request

Path

GET https://[stg.]api.bazaarvoice.com/psi/v1/data
Path tokens
Name Description
[stg.]

Optional subdomain indicating the request should use the non-production environment. Omit to use production. In either case, production data will be returned. Learn more at Getting Started.

Headers

Host: [stg.]api.bazaarvoice.com
X-Bazaarvoice-Passkey: {PSI_PASSKEY}
X-Bazaarvoice-Signature: {SIGNATURE}
X-Bazaarvoice-Timestamp: {TIMESTAMP}

Refer to the Reference section for details on the headers and their values.

Access signature values

Replace the {SIGNATURE} token above with the following string, encrypted using the algorithm described at Creating the Access Signature.

passkey={PSI_PASSKEY}&timestamp={TIMESTAMP}

Replace the tokens above with the appropriate values as described below:

Name Description
{PSI_PASSKEY}

This is the same value communicated with the X-Bazaarvoice-Passkey header.

{TIMESTAMP}

A Unix timestamp in milliseconds. This is the same value communicated by the X-Bazaarvoice-Timestamp header.

Using seconds or any increment other than milliseconds will cause your request to fail

Response

Response will be a JSON object containing URL paths corresponding to available manifests. The following demonstrates a typical response:

{
  "manifests":[
    {
      "version":"v1",
      "fulls":[
        {
          "date":"2019-01-07",
          "path":"/manifests/full/2019-01-07/v1/manifest.json"
        },
        {
          "date":"2019-01-08",
          "path":"/manifests/full/2019-01-08/v1/manifest.json"
        }
      ]
    }
  ]
}

Full manifests contain all product sentiment insights data and are generated once a week. Use the most recently generated manifest to get a complete snapshot of your product sentiment insights data.

The URL paths will be used in the next step.