Bazaarvoice Developer Portal | 4. Request CGC Data File Location

The Bazaarvoice Displayable Content Export (DCE) provides an HTTP interface for bulk requesting Bazaarvoice Conversations data intended for public display. To learn more, go to the DCE documentation home page.

Contents

(+ show- hide)

Your application should parse the manifest file from the previous step for the data that you want and use the file paths from the manifest to make requests for that data as described in this step. This request will return a 302 redirect to the location of the manifest file.

Request

Path

GET https://[stg.]api.bazaarvoice.com/dce/v3/data?path={CGC_DATA_PATH}

Path tokens

Name Description

Name	Description
`[stg.]`	Optional subdomain indicating the request should use the non-production environment. Omit to use production. Learn more at the Reference section.
`{CGC_DATA_PATH}`	This is a file path found in the manifest acquired from the previous step. ⚠ The file path must be used exactly as it is. Any modification will result in the DCE returning an error.

[stg.]

Optional subdomain indicating the request should use the non-production environment. Omit to use production. Learn more at the Reference section.

{CGC_DATA_PATH}

This is a file path found in the manifest acquired from the previous step.

⚠ The file path must be used exactly as it is. Any modification will result in the DCE returning an error.

Headers

Host: [stg.]api.bazaarvoice.com
X-Bazaarvoice-Passkey: {DCE_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.

path={CGC_DATA_PATH}&passkey={DCE_PASSKEY}&timestamp={TIMESTAMP}

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

Name Description

Name	Description
`{CGC_DATA_PATH}`	This is a file path found in the manifest acquired from the previous step. This is the same value communicated in the `path` query string parameter.
`{DCE_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

{CGC_DATA_PATH}

This is a file path found in the manifest acquired from the previous step. This is the same value communicated in the path query string parameter.

{DCE_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 HTTP 302 redirect to the location of a CGC data file. The response will also include the location path value in the body of the request as a convenience for applications that cannot be configured to follow the redirect automatically. The following demonstrates a typical response:

HTTP/1.1 302 Found
Content-Type: application/json
Location: {CGC_DATA_URL}

{"location":"{CGC_DATA_URL}"}

Your application should be configured to follow this redirect as described in the next step.

The next step will describe how your application can use the location path value to request a CGC data file.