API REFERENCE
Monitor History API
GET
/v1/monitor/history-listFree·api.etshop.ai/open-apiCredits usage rules
Billing: shop/product lists and top sellers cost 1 Credit per returned record; shop details cost 2 Credits per call. Details, trends, daily data and reviews are free (the record must have been returned by a list or details call within 3 days). Keyword search costs 1 Keyword Credit per keyword, and the same keyword is free for 30 days. Shop monitoring costs 1 Monitor Credit per shop for 30 days and is not refunded when stopped. Empty results are free and server errors are refunded automatically.
Request headers
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/jsonRequest example
cURL
curl --location --request GET 'https://api.etshop.ai/open-api/v1/monitor/history-list?page=1&per_page=10' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' Request parameters
Pass each parameter in its specified location.
| Parameter | Type | Description |
|---|---|---|
| page
query · optional
| integer | Page number (min: 1, default: 1). |
| per_page
query · optional
| integer | Items per page (range: 1-100, default: 10). |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"current_page": 1,
"data": [
{
"id": 1017,
"shop_id": 31570284,
"name": "LunaGoldJewelryCo",
"image": "https://i.etsystatic.com/isla/f02c4d/63950172/isla_500x500.63950172_r8w1nq3d.jpg",
"url": "https://www.etsy.com/shop/LunaGoldJewelryCo",
"country_code": "TR",
"have_sold_page": 1,
"group_id": "3f9c2a7e5b1d4c8e9a6f0b2d7e4c1a95",
"monitor_task_started_at": 1791849600,
"monitor_task_stoped_at": 1792886400
},
{
"id": 1009,
"shop_id": 22918453,
"name": "WillowAndWickCandles",
"image": "https://i.etsystatic.com/isla/7ad391/50382614/isla_500x500.50382614_c5h0kt2y.jpg",
"url": "https://www.etsy.com/shop/WillowAndWickCandles",
"country_code": "CA",
"have_sold_page": 0,
"group_id": null,
"monitor_task_started_at": 1789437600,
"monitor_task_stoped_at": 1792029600
}
],
"first_page_url": "https://api.etshop.ai/open-api/v1/monitor/history-list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://api.etshop.ai/open-api/v1/monitor/history-list?page=1",
"next_page_url": null,
"path": "https://api.etshop.ai/open-api/v1/monitor/history-list",
"per_page": 10,
"prev_page_url": null,
"to": 2,
"total": 2
},
"credits": {
"type": "monitor_credits",
"remaining_credits": 98,
"consumed_credits": 0,
"total_credits": 100
}
}
Example data from the existing documentation
Response structure
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
| » code | integer | true | none | Status Code |
| » message | string | true | none | Response message |
| » data | object | true | none | Response data |
| »» current_page | integer | true | none | Current page number |
| »» data | [object] | true | none | Monitor history |
| »»» id | integer | true | none | Monitor ID, used by Delete Monitors |
| »»» shop_id | integer | true | none | Shop ID |
| »»» name | string | true | none | Shop name |
| »»» image | string | true | none | Shop icon |
| »»» url | string | true | none | Shop URL |
| »»» country_code | string | true | none | Shop country/region code |
| »»» have_sold_page | integer | true | none | Whether the shop has a public sold page: 1 = yes, 0 = no |
| »»» group_id | string | null | true | none | Group ID; pass it to Add Monitors to keep the original group when monitoring again. null if ungrouped or the group was deleted |
| »»» monitor_task_started_at | integer | true | none | Start time of the latest monitoring period (Unix timestamp, seconds) |
| »»» monitor_task_stoped_at | integer | true | none | Stop time of the latest monitoring period (Unix timestamp, seconds) |
| »» first_page_url | string | true | none | URL of the first page |
| »» from | integer | null | true | none | Index of the first item on this page |
| »» last_page | integer | true | none | Last page number |
| »» last_page_url | string | true | none | URL of the last page |
| »» next_page_url | string | null | true | none | URL of the next page |
| »» path | string | true | none | Endpoint URL |
| »» per_page | integer | true | none | Items per page |
| »» prev_page_url | string | null | true | none | URL of the previous page |
| »» to | integer | null | true | none | Index of the last item on this page |
| »» total | integer | true | none | Total records |
| » credits | object | true | none | Credits information of this request. See Billing Rules. |
| »» type | string | true | none | Credits type. monitor_credits for this endpoint. |
| »» remaining_credits | integer | true | none | Remaining Monitor Credits after this request |
| »» consumed_credits | integer | true | none | Monitor Credits consumed by this request (0 for this endpoint) |
| »» total_credits | integer | true | none | Total Monitor Credits |
