---
updatedAt: 2026-04-12T09:23:21.000Z
---

# Get the Top Search Trends via Insights endpoint

# Description

**You can download Top Search Trends report using insight download link with help of this API**

**URL:** ​GET/api/v1/insights

# Query Parameters

| Parameter    | Description                     | type   | Required | Possible Values |
| ------------ | ------------------------------- | ------ | -------- | --------------- |
| insightsType | The type of insight             | string | Y        | searchTrends    |
| format       | Format of the downloadable file | string | Y        | zip, gzip       |

## Headers

## Headers

| Header Name              | Description                                                                                                            | Required | Values                                                                                                                                           |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Authorization            | The token will provide you the access to the API. It is same for all advertisers you access through the API.           | Y        | Please utilize the generated `auth_token` shared with you at the time of partner onboarding from the Getting Started Guide                       |
| WM\_CONSUMER.ID          | We will provide you the consumer ID to access the API. It is same for all advertisers you access   through the API.    | Y        | Please use the generated `ConsumerId` shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information |
| WM\_SEC.AUTH\_SIGNATURE  | Auth signature as an API key.                                                                                          | Y        | Use the signature generator code from Getting Started Guide to generate this value                                                               |
| WM\_SEC.KEY\_VERSION     | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API. | Y        | 1                                                                                                                                                |
| WM\_CONSUMER.intimestamp | Timestamp for  which the auth signature is generated. Use Unix epoch format for the timestamp.                         | Y        | Use the signature generator code from Getting Started Guide to generate this value                                                               |
| Content-Type             | Format of the message body                                                                                             | Y        | application/json                                                                                                                                 |

<br />

## Sample Request

```
curl -X GET \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/insights?insightsType=searchTrends&format=zip' \
--header 'Authorization: Bearer <auth_token>' \ 
--header 'accept: application/json' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
```

# Response

| Element  | Description                                       | Type   |
| -------- | ------------------------------------------------- | ------ |
| download | Get the link to download Top Search Trends Report | string |

## Sample Response

```
[
    { "download": https://advertising.walmart.com/qa/file/55 }
]
```