[{"data":1,"prerenderedAt":752},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fapi\u002Freference":3,"docs-nav":603},{"id":4,"title":5,"body":6,"description":594,"extension":595,"meta":596,"navigation":597,"order":598,"path":599,"seo":600,"stem":601,"__hash__":602},"docs\u002Fdocs\u002F4.api\u002F3.reference.md","API reference",{"type":7,"value":8,"toc":581},"minimark",[9,32,37,105,109,216,220,317,321,338,342,414,425,429,503,510,514,552,561,565],[10,11,12,13,17,18,21,22,27,28,31],"p",{},"All paths are relative to ",[14,15,16],"code",{},"https:\u002F\u002Fapi.trafficox.com\u002Fapi"," and need the\n",[14,19,20],{},"Api-Key"," header — see ",[23,24,26],"a",{"href":25},"\u002Fdocs\u002Fapi\u002Fauthentication","API authentication",". ",[14,29,30],{},":id","\naccepts the numeric ID shown in the platform.",[33,34,36],"h2",{"id":35},"account","Account",[38,39,40,56],"table",{},[41,42,43],"thead",{},[44,45,46,50,53],"tr",{},[47,48,49],"th",{},"Method",[47,51,52],{},"Path",[47,54,55],{},"What it does",[57,58,59,73,93],"tbody",{},[44,60,61,65,70],{},[62,63,64],"td",{},"GET",[62,66,67],{},[14,68,69],{},"\u002Fv1\u002Fme",[62,71,72],{},"Your account: email, username and total balance",[44,74,75,77,82],{},[62,76,64],{},[62,78,79],{},[14,80,81],{},"\u002Fv1\u002Fbalance_stats",[62,83,84,85,88,89,92],{},"What you earned and spent per day. Takes ",[14,86,87],{},"date_start"," and ",[14,90,91],{},"date_end","; up to 60 days at a time, no more than 90 days back",[44,94,95,97,102],{},[62,96,64],{},[62,98,99],{},[14,100,101],{},"\u002Fv1\u002Ffilters",[62,103,104],{},"The values you can use in filters: countries, categories, operating systems, browsers and platforms",[33,106,108],{"id":107},"domain-filters","Domain filters",[38,110,111,121],{},[41,112,113],{},[44,114,115,117,119],{},[47,116,49],{},[47,118,52],{},[47,120,55],{},[57,122,123,149,164,176,188,204],{},[44,124,125,127,132],{},[62,126,64],{},[62,128,129],{},[14,130,131],{},"\u002Fv1\u002Fdomain_filters",[62,133,134,135,138,139,142,143,88,146],{},"Your lists. Takes ",[14,136,137],{},"page",", ",[14,140,141],{},"length"," (up to 20), ",[14,144,145],{},"search",[14,147,148],{},"list_type",[44,150,151,154,158],{},[62,152,153],{},"POST",[62,155,156],{},[14,157,131],{},[62,159,160,161],{},"Create a list. Body: ",[14,162,163],{},"{\"domain_filter\":{\"name\":\"…\",\"list_type\":\"blacklist\",\"domains\":[\"example.com\"]}}",[44,165,166,168,173],{},[62,167,64],{},[62,169,170],{},[14,171,172],{},"\u002Fv1\u002Fdomain_filters\u002F:id",[62,174,175],{},"One list",[44,177,178,181,185],{},[62,179,180],{},"PUT, PATCH",[62,182,183],{},[14,184,172],{},[62,186,187],{},"Update a list",[44,189,190,192,197],{},[62,191,153],{},[62,193,194],{},[14,195,196],{},"\u002Fv1\u002Fdomain_filters\u002F:id\u002Fadd_domains",[62,198,199,200,203],{},"Add domains. Body: ",[14,201,202],{},"{\"domains\":[\"a.com\",\"b.com\"]}",", up to 15,000",[44,205,206,208,213],{},[62,207,153],{},[62,209,210],{},[14,211,212],{},"\u002Fv1\u002Fdomain_filters\u002F:id\u002Fremove_domains",[62,214,215],{},"Remove domains, same body",[33,217,219],{"id":218},"popunder-buy-orders","Popunder buy orders",[38,221,222,232],{},[41,223,224],{},[44,225,226,228,230],{},[47,227,49],{},[47,229,52],{},[47,231,55],{},[57,233,234,246,258,277,289,301],{},[44,235,236,238,243],{},[62,237,64],{},[62,239,240],{},[14,241,242],{},"\u002Fv1\u002Fpopunder\u002Fbuy_orders",[62,244,245],{},"All your popunder buy orders",[44,247,248,250,255],{},[62,249,64],{},[62,251,252],{},[14,253,254],{},"\u002Fv1\u002Fpopunder\u002Fbuy_orders\u002F:id",[62,256,257],{},"One order with its targeting and limits",[44,259,260,263,267],{},[62,261,262],{},"PATCH",[62,264,265],{},[14,266,254],{},[62,268,269,270,273,274],{},"Change ",[14,271,272],{},"bid_price"," or attach a ",[14,275,276],{},"domain_filter_id",[44,278,279,281,286],{},[62,280,153],{},[62,282,283],{},[14,284,285],{},"\u002Fv1\u002Fpopunder\u002Fbuy_orders\u002F:id\u002Fplay",[62,287,288],{},"Resume a paused order",[44,290,291,293,298],{},[62,292,153],{},[62,294,295],{},[14,296,297],{},"\u002Fv1\u002Fpopunder\u002Fbuy_orders\u002F:id\u002Fpause",[62,299,300],{},"Pause an order",[44,302,303,305,310],{},[62,304,153],{},[62,306,307],{},[14,308,309],{},"\u002Fv1\u002Fpopunder\u002Fbuy_orders\u002F:id\u002Fstats\u002F{breakdown}",[62,311,312,313],{},"Statistics — see ",[23,314,316],{"href":315},"\u002Fdocs\u002Fapi\u002Fstatistics#breakdowns","breakdowns",[33,318,320],{"id":319},"sticky-banner-buy-orders","Sticky banner buy orders",[10,322,323,324,327,328,138,330,333,334,337],{},"The same endpoints under ",[14,325,326],{},"\u002Fv1\u002Fsticker\u002Fbuy_orders",", including ",[14,329,262],{},[14,331,332],{},"play",",\n",[14,335,336],{},"pause"," and statistics.",[33,339,341],{"id":340},"sell-orders","Sell orders",[38,343,344,354],{},[41,345,346],{},[44,347,348,350,352],{},[47,349,49],{},[47,351,52],{},[47,353,55],{},[57,355,356,368,380,395],{},[44,357,358,360,365],{},[62,359,64],{},[62,361,362],{},[14,363,364],{},"\u002Fv1\u002Fpopunder\u002Fsell_orders",[62,366,367],{},"All your popunder sell orders",[44,369,370,372,377],{},[62,371,64],{},[62,373,374],{},[14,375,376],{},"\u002Fv1\u002Fpopunder\u002Fsell_orders\u002F:id",[62,378,379],{},"One order",[44,381,382,384,389],{},[62,383,153],{},[62,385,386],{},[14,387,388],{},"\u002Fv1\u002Fpopunder\u002Fsell_orders\u002F:id\u002Fstats\u002F{breakdown}",[62,390,391,392],{},"Statistics, including ",[14,393,394],{},"sub_ids",[44,396,397,399,404],{},[62,398,153],{},[62,400,401],{},[14,402,403],{},"\u002Fv2\u002Fsell_orders\u002F:id\u002Fstats\u002Fsub_ids",[62,405,406,407,138,410,413],{},"Statistics by up to three sub IDs, with cursor paging (",[14,408,409],{},"size",[14,411,412],{},"after",")",[10,415,416,417,420,421,424],{},"Sticky banner sell orders use ",[14,418,419],{},"\u002Fv1\u002Fsticker\u002Fsell_orders"," the same way; their\nstatistics have no ",[14,422,423],{},"domain"," breakdown.",[33,426,428],{"id":427},"rtb-feeds","RTB feeds",[38,430,431,441],{},[41,432,433],{},[44,434,435,437,439],{},[47,436,49],{},[47,438,52],{},[47,440,55],{},[57,442,443,455,467,479,491],{},[44,444,445,447,452],{},[62,446,64],{},[62,448,449],{},[14,450,451],{},"\u002Fv1\u002Fpopunder\u002Frtb_feeds",[62,453,454],{},"Your popunder RTB feeds",[44,456,457,459,464],{},[62,458,64],{},[62,460,461],{},[14,462,463],{},"\u002Fv1\u002Fpopunder\u002Frtb_feeds\u002F:id",[62,465,466],{},"One feed",[44,468,469,471,476],{},[62,470,153],{},[62,472,473],{},[14,474,475],{},"\u002Fv1\u002Fpopunder\u002Frtb_feeds\u002F:id\u002Fplay",[62,477,478],{},"Resume a feed",[44,480,481,483,488],{},[62,482,153],{},[62,484,485],{},[14,486,487],{},"\u002Fv1\u002Fpopunder\u002Frtb_feeds\u002F:id\u002Fpause",[62,489,490],{},"Pause a feed",[44,492,493,495,500],{},[62,494,153],{},[62,496,497],{},[14,498,499],{},"\u002Fv1\u002Fpopunder\u002Frtb_feeds\u002F:id\u002Fstats\u002F{breakdown}",[62,501,502],{},"Feed statistics",[10,504,505,506,509],{},"Sticky banner feeds use ",[14,507,508],{},"\u002Fv1\u002Fsticker\u002Frtb_feeds",".",[33,511,513],{"id":512},"rtb-statistics-for-the-whole-account","RTB statistics for the whole account",[38,515,516,526],{},[41,517,518],{},[44,519,520,522,524],{},[47,521,49],{},[47,523,52],{},[47,525,55],{},[57,527,528,540],{},[44,529,530,532,537],{},[62,531,153],{},[62,533,534],{},[14,535,536],{},"\u002Fv1\u002Frtb_stats\u002F{breakdown}",[62,538,539],{},"Popunder RTB statistics across all your feeds",[44,541,542,544,549],{},[62,543,153],{},[62,545,546],{},[14,547,548],{},"\u002Fv1\u002Fsticker\u002Frtb_stats\u002F{breakdown}",[62,550,551],{},"The same for sticky banners",[10,553,554,555,88,558,560],{},"RTB statistics take ",[14,556,557],{},"from",[14,559,409],{}," (default 10) for paging and cover up to\n60 days at a time, no more than 90 days back.",[33,562,564],{"id":563},"related","Related",[566,567,568,575],"ul",{},[569,570,571],"li",{},[23,572,574],{"href":573},"\u002Fdocs\u002Fapi\u002Fstatistics","Statistics requests",[569,576,577],{},[23,578,580],{"href":579},"\u002Fdocs\u002Fapi\u002Fquickstart","API quickstart",{"title":582,"searchDepth":583,"depth":583,"links":584},"",3,[585,587,588,589,590,591,592,593],{"id":35,"depth":586,"text":36},2,{"id":107,"depth":586,"text":108},{"id":218,"depth":586,"text":219},{"id":319,"depth":586,"text":320},{"id":340,"depth":586,"text":341},{"id":427,"depth":586,"text":428},{"id":512,"depth":586,"text":513},{"id":563,"depth":586,"text":564},"Every endpoint of the TrafficOX API, grouped by what it manages.","md",{},true,null,"\u002Fdocs\u002Fapi\u002Freference",{"title":5,"description":594},"docs\u002F4.api\u002F3.reference","HrJ_0SZCION9r1y8SBj5OoY24bGKI5el9fYTGia0wG8",[604],{"title":605,"path":606,"stem":607,"children":608},"Docs","\u002Fdocs","docs",[609,613,639,693,732,747],{"title":610,"path":606,"stem":611,"description":612},"TrafficOX Documentation","docs\u002Findex","How to buy and sell traffic on TrafficOX — from your first top-up to tracking conversions.",{"title":614,"path":615,"stem":616,"children":617,"page":638},"Getting Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started",[618,623,628,633],{"title":619,"path":620,"stem":621,"description":622},"Create your account","\u002Fdocs\u002Fgetting-started\u002Faccount","docs\u002F1.getting-started\u002F1.account","Sign up, confirm your email, complete your profile and secure your account.",{"title":624,"path":625,"stem":626,"description":627},"Top up your balance","\u002Fdocs\u002Fgetting-started\u002Ftop-up","docs\u002F1.getting-started\u002F2.top-up","Payment methods, minimum amounts, VAT, and what your first top-up unlocks.",{"title":629,"path":630,"stem":631,"description":632},"How your balance works","\u002Fdocs\u002Fgetting-started\u002Fbalance","docs\u002F1.getting-started\u002F3.balance","Buyer, seller and reserved balance — what each one holds, what you can spend and what you can withdraw.",{"title":634,"path":635,"stem":636,"description":637},"Referral program","\u002Fdocs\u002Fgetting-started\u002Freferrals","docs\u002F1.getting-started\u002F4.referrals","Invite advertisers and publishers with your link and earn 5% from them.",false,{"title":640,"path":641,"stem":642,"children":643,"page":638},"Advertisers","\u002Fdocs\u002Fadvertisers","docs\u002F2.advertisers",[644,649,654,659,664,669,674,678,683,688],{"title":645,"path":646,"stem":647,"description":648},"How buy orders work","\u002Fdocs\u002Fadvertisers\u002Fbuy-orders","docs\u002F2.advertisers\u002F01.buy-orders","What a buy order is, the ad formats you can buy, and what each order status means.",{"title":650,"path":651,"stem":652,"description":653},"Create a buy order","\u002Fdocs\u002Fadvertisers\u002Fcreate-buy-order","docs\u002F2.advertisers\u002F02.create-buy-order","Walk through the five steps of the order wizard — general settings, ads, targeting, pricing and limits.",{"title":655,"path":656,"stem":657,"description":658},"Targeting reference","\u002Fdocs\u002Fadvertisers\u002Ftargeting","docs\u002F2.advertisers\u002F03.targeting","Every targeting option in a buy order — what it does, its default, and how to narrow or block traffic.",{"title":660,"path":661,"stem":662,"description":663},"Landing pages and creatives","\u002Fdocs\u002Fadvertisers\u002Flanding-pages","docs\u002F2.advertisers\u002F04.landing-pages","Save landing page URLs and banner images in the Media Library, get them approved, and reuse them across orders.",{"title":665,"path":666,"stem":667,"description":668},"Track conversions","\u002Fdocs\u002Fadvertisers\u002Ftrack-conversions","docs\u002F2.advertisers\u002F05.track-conversions","Send conversions back to TrafficOX with a server-to-server postback or a pixel, and see cost per conversion and ROI in your stats.",{"title":670,"path":671,"stem":672,"description":673},"URL macros","\u002Fdocs\u002Fadvertisers\u002Furl-macros","docs\u002F2.advertisers\u002F06.url-macros","Placeholders you can put in your landing page URL — TrafficOX fills them in on every click.",{"title":108,"path":675,"stem":676,"description":677},"\u002Fdocs\u002Fadvertisers\u002Fdomain-filters","docs\u002F2.advertisers\u002F07.domain-filters","Keep lists of sites to buy from or to avoid, and attach them to your buy orders.",{"title":679,"path":680,"stem":681,"description":682},"Automation rules","\u002Fdocs\u002Fadvertisers\u002Fautomation-rules","docs\u002F2.advertisers\u002F08.automation-rules","Let TrafficOX raise or lower bids and black- or whitelist sources for you, based on your statistics.",{"title":684,"path":685,"stem":686,"description":687},"Read your statistics","\u002Fdocs\u002Fadvertisers\u002Fstatistics","docs\u002F2.advertisers\u002F09.statistics","Where to find your numbers — the dashboard, order statistics and total stats — and what each metric means.",{"title":689,"path":690,"stem":691,"description":692},"Buy through an RTB feed","\u002Fdocs\u002Fadvertisers\u002Frtb-feeds","docs\u002F2.advertisers\u002F10.rtb-feeds","Connect your DSP endpoint so TrafficOX sends you bid requests and you answer with bids.",{"title":694,"path":695,"stem":696,"children":697,"page":638},"Publishers","\u002Fdocs\u002Fpublishers","docs\u002F3.publishers",[698,703,708,713,718,723,727],{"title":699,"path":700,"stem":701,"description":702},"How selling works","\u002Fdocs\u002Fpublishers\u002Fhow-selling-works","docs\u002F3.publishers\u002F1.how-selling-works","Sell orders, the formats you can sell, and how your sites are approved before traffic is bought.",{"title":704,"path":705,"stem":706,"description":707},"Add and verify your domains","\u002Fdocs\u002Fpublishers\u002Fdomains","docs\u002F3.publishers\u002F2.domains","Add your sites, prove you own them, and get them approved so their traffic is bought.",{"title":709,"path":710,"stem":711,"description":712},"Create a sell order","\u002Fdocs\u002Fpublishers\u002Fcreate-sell-order","docs\u002F3.publishers\u002F3.create-sell-order","Set up a placement — name, price floor, fallback URL and the settings for popunder or sticky banners.",{"title":714,"path":715,"stem":716,"description":717},"Install the code","\u002Fdocs\u002Fpublishers\u002Finstall-code","docs\u002F3.publishers\u002F4.install-code","Put your sell order's script on your site, pass a sub ID, and add the lite script to the rest of your pages.",{"title":719,"path":720,"stem":721,"description":722},"Better Ads status","\u002Fdocs\u002Fpublishers\u002Fbetter-ads","docs\u002F3.publishers\u002F5.better-ads","Check whether ad-quality lists and Chrome's filters affect your domains, and what to do if they do.",{"title":684,"path":724,"stem":725,"description":726},"\u002Fdocs\u002Fpublishers\u002Fstatistics","docs\u002F3.publishers\u002F6.statistics","Your earnings, sold and returned traffic on the dashboard, per sell order and in total.",{"title":728,"path":729,"stem":730,"description":731},"Withdraw your earnings","\u002Fdocs\u002Fpublishers\u002Fwithdrawals","docs\u002F3.publishers\u002F7.withdrawals","Request a payout of your seller balance by Capitalist, Paxum or wire transfer.",{"title":733,"path":734,"stem":735,"children":736,"page":638},"Api","\u002Fdocs\u002Fapi","docs\u002F4.api",[737,740,743,744],{"title":26,"path":25,"stem":738,"description":739},"docs\u002F4.api\u002F1.authentication","Create an API key, authenticate your requests, and understand the API's conventions and errors.",{"title":580,"path":579,"stem":741,"description":742},"docs\u002F4.api\u002F2.quickstart","Three requests to get going — check your account, pull yesterday's stats by country, and pause an order.",{"title":5,"path":599,"stem":601,"description":594},{"title":574,"path":573,"stem":745,"description":746},"docs\u002F4.api\u002F4.statistics","Breakdowns, filters, sub-breakdowns and the fields returned by every statistics endpoint.",{"title":748,"path":749,"stem":750,"description":751},"Glossary","\u002Fdocs\u002Fglossary","docs\u002F5.glossary","The terms used across TrafficOX and these docs, in plain words.",1793025806022]