{"_id":"5cf106dbc544be002d22e56f","project":"567f0c06143cc60d00c1fdbe","version":{"_id":"567f0c06143cc60d00c1fdc1","__v":9,"project":"567f0c06143cc60d00c1fdbe","createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"5bf1a1473031e4005075ae14","project":"567f0c06143cc60d00c1fdbe","version":"567f0c06143cc60d00c1fdc1","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-11-18T17:28:39.716Z","from_sync":false,"order":5,"slug":"performance","title":"Statistics"},"user":"567f0baca74a1c0d003e1fba","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-31T10:50:03.396Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"curl -X GET https://tophatter.com/merchant_api/v1/performance/auctions.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\t\n-d 'duration=yesterday' \\\t\n-d 'category=Electronics' \\\t\n-d 'campaign_name=test' ","language":"curl"}]},"settings":"","results":{"codes":[{"name":"","code":"[\n    {\n        \"table\": {\n            \"identifier\": \"THProductTest001\",\n            \"cost_basis\": \"10.0\",\n            \"schedules\": 1,\n            \"orders\": 1,\n            \"revenue\": 7,\n            \"fees\": 2.68,\n            \"scheduling_fees\": 1.55\n        }\n    }\n]","language":"json","status":200}]},"auth":"required","params":[{"_id":"5c629f7b22c28f0044dedf62","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"access_token"},{"_id":"5c629f7b22c28f0044dedf61","ref":"","in":"query","required":false,"desc":"Optional - Filter the results by determined date duration. Possible values - today, yesterday, last_week, month_to_date, last_month, last_2_months","default":"","type":"string","name":"duration"},{"_id":"5c629f7b22c28f0044dedf60","ref":"","in":"query","required":false,"desc":"Optional - Filter the results by product category. If not set, products under all categories are returned.","default":"","type":"string","name":"category"},{"_id":"5c629f7b22c28f0044dedf5f","ref":"","in":"query","required":false,"desc":"Optional - Filter the results by product's campaign name.","default":"","type":"string","name":"campaign_name"}],"url":"/performance/auctions.json"},"isReference":false,"order":999,"body":"","excerpt":"","slug":"auctions","type":"endpoint","title":"Auctions"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

access_token:
string
duration:
string
Optional - Filter the results by determined date duration. Possible values - today, yesterday, last_week, month_to_date, last_month, last_2_months
category:
string
Optional - Filter the results by product category. If not set, products under all categories are returned.
campaign_name:
string
Optional - Filter the results by product's campaign name.

Examples


Result Format