{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/performance/auctions.json","auth":"required","method":"get","examples":{"codes":[{"language":"curl","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' "}]},"settings":"","results":{"codes":[{"status":200,"language":"json","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]","name":""}]},"params":[{"name":"access_token","type":"string","default":"","desc":"","required":false,"in":"query","ref":"","_id":"5c629f7b22c28f0044dedf62"},{"name":"duration","type":"string","default":"","desc":"Optional - Filter the results by determined date duration. Possible values - today, yesterday, last_week, month_to_date, last_month, last_2_months","required":false,"in":"query","ref":"","_id":"5c629f7b22c28f0044dedf61"},{"name":"category","type":"string","default":"","desc":"Optional - Filter the results by product category. If not set, products under all categories are returned.","required":false,"in":"query","ref":"","_id":"5c629f7b22c28f0044dedf60"},{"name":"campaign_name","type":"string","default":"","desc":"Optional - Filter the results by product's campaign name.","required":false,"in":"query","ref":"","_id":"5c629f7b22c28f0044dedf5f"}]},"next":{"description":"","pages":[]},"title":"Auctions","type":"endpoint","slug":"auctions","excerpt":"","body":"","updates":["5d6afc0c69c5d20150024124"],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cf106dbc544be002d22e56f","project":"567f0c06143cc60d00c1fdbe","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"_id":"567f0c06143cc60d00c1fdc1","__v":9,"createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","project":"567f0c06143cc60d00c1fdbe"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Statistics","slug":"performance","order":5,"from_sync":false,"reference":false,"_id":"5bf1a1473031e4005075ae14","project":"567f0c06143cc60d00c1fdbe","version":"567f0c06143cc60d00c1fdc1","createdAt":"2018-11-18T17:28:39.716Z","__v":0},"user":"567f0baca74a1c0d003e1fba","createdAt":"2019-05-31T10:50:03.396Z","__v":2,"parentDoc":null}

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