> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.pivolio.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivolio.com/_mcp/server. # Pixel fallback GET /pixel Records a conversion from typed query parameters for image pixels and server-to-server postbacks that can't run JS, authenticating with ``?wk=`` or the ``X-Write-Key`` header. With ``format=img`` it returns a 1x1 GIF and sets the anonymous-id cookie; otherwise it returns a JSON CollectorResponse. Reference: https://docs.pivolio.com/api-reference/pivolio/event-ingestion/ingest-pixel ## Authentication - `X-Write-Key` header (required) — API Key authentication via header ## Request ### Query parameters - `event` (string, required) - `wk` (string, optional, nullable) - `format` (enum, optional, nullable) - Allowed values: `img`, `json` - `eid` (string, optional, nullable) - `aid` (string, optional, nullable) - `uid` (string, optional, nullable) - `ts` (double, optional, nullable) - `value` (double, optional, nullable) - `currency` (string, optional, nullable) - `fbclid` (string, optional, nullable) - `fbp` (string, optional, nullable) - `fbc` (string, optional, nullable) - `gclid` (string, optional, nullable) - `gbraid` (string, optional, nullable) - `wbraid` (string, optional, nullable) - `ttclid` (string, optional, nullable) - `ttp` (string, optional, nullable) - `li_fat_id` (string, optional, nullable) - `msclkid` (string, optional, nullable) - `epik` (string, optional, nullable) - `rdt_cid` (string, optional, nullable) - `sc_click_id` (string, optional, nullable) - `twclid` (string, optional, nullable) ## Response ### 200 Conversion recorded. Returns a 1x1 transparent GIF when `format=img`; otherwise a JSON CollectorResponse. - `ok` (boolean, optional, default: true) - `event_id` (string, optional, nullable) - `duplicate` (boolean, optional, default: false) ## Errors ### 401 Unauthorized Error Missing or invalid write key - `any` ### 422 Unprocessable Entity Error Validation Error - `detail` (string, required) - `code` (string, required) - `errors` (list of FieldError, optional, nullable) ## Types ### FieldError - `field` (string, required) - `message` (string, required) ## Examples **Response** ```json { "ok": true, "event_id": "evt_20240615_001", "duplicate": false } ``` **SDK Code** ```python import requests url = "https://api.example.com/pixel" querystring = {"aid":"ad_987654321","currency":"USD","eid":"evt_20240615_001","epik":"epik_example_123456","event":"purchase","fbc":"fb.1.1680000000000.IwAR0Example","fbclid":"IwAR0FbclidExample1234567890","fbp":"fb.1.1680000000000.1234567890","format":"json","gbraid":"GBRAID1234567890abcdef","gclid":"Cj0KCQjw8rOaBhD0ARIsALk3v1","li_fat_id":"li_fat_id_123456","msclkid":"MSCLKID1234567890abcdef","rdt_cid":"rdt_cid_abcdef123456","sc_click_id":"sc_click_id_1234567890","ts":"1718505600","ttclid":"TTCLID1234567890abcdef","ttp":"ttp_example_value","twclid":"twclid_example_123456","uid":"user_123456789","value":"49.99","wbraid":"WBRAIDabcdef1234567890","wk":"abc123writekey789xyz"} headers = {"X-Write-Key": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.example.com/pixel?aid=ad_987654321¤cy=USD&eid=evt_20240615_001&epik=epik_example_123456&event=purchase&fbc=fb.1.1680000000000.IwAR0Example&fbclid=IwAR0FbclidExample1234567890&fbp=fb.1.1680000000000.1234567890&format=json&gbraid=GBRAID1234567890abcdef&gclid=Cj0KCQjw8rOaBhD0ARIsALk3v1&li_fat_id=li_fat_id_123456&msclkid=MSCLKID1234567890abcdef&rdt_cid=rdt_cid_abcdef123456&sc_click_id=sc_click_id_1234567890&ts=1718505600&ttclid=TTCLID1234567890abcdef&ttp=ttp_example_value&twclid=twclid_example_123456&uid=user_123456789&value=49.99&wbraid=WBRAIDabcdef1234567890&wk=abc123writekey789xyz'; const options = {method: 'GET', headers: {'X-Write-Key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.example.com/pixel?aid=ad_987654321¤cy=USD&eid=evt_20240615_001&epik=epik_example_123456&event=purchase&fbc=fb.1.1680000000000.IwAR0Example&fbclid=IwAR0FbclidExample1234567890&fbp=fb.1.1680000000000.1234567890&format=json&gbraid=GBRAID1234567890abcdef&gclid=Cj0KCQjw8rOaBhD0ARIsALk3v1&li_fat_id=li_fat_id_123456&msclkid=MSCLKID1234567890abcdef&rdt_cid=rdt_cid_abcdef123456&sc_click_id=sc_click_id_1234567890&ts=1718505600&ttclid=TTCLID1234567890abcdef&ttp=ttp_example_value&twclid=twclid_example_123456&uid=user_123456789&value=49.99&wbraid=WBRAIDabcdef1234567890&wk=abc123writekey789xyz" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Write-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.example.com/pixel?aid=ad_987654321¤cy=USD&eid=evt_20240615_001&epik=epik_example_123456&event=purchase&fbc=fb.1.1680000000000.IwAR0Example&fbclid=IwAR0FbclidExample1234567890&fbp=fb.1.1680000000000.1234567890&format=json&gbraid=GBRAID1234567890abcdef&gclid=Cj0KCQjw8rOaBhD0ARIsALk3v1&li_fat_id=li_fat_id_123456&msclkid=MSCLKID1234567890abcdef&rdt_cid=rdt_cid_abcdef123456&sc_click_id=sc_click_id_1234567890&ts=1718505600&ttclid=TTCLID1234567890abcdef&ttp=ttp_example_value&twclid=twclid_example_123456&uid=user_123456789&value=49.99&wbraid=WBRAIDabcdef1234567890&wk=abc123writekey789xyz") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Write-Key"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.example.com/pixel?aid=ad_987654321¤cy=USD&eid=evt_20240615_001&epik=epik_example_123456&event=purchase&fbc=fb.1.1680000000000.IwAR0Example&fbclid=IwAR0FbclidExample1234567890&fbp=fb.1.1680000000000.1234567890&format=json&gbraid=GBRAID1234567890abcdef&gclid=Cj0KCQjw8rOaBhD0ARIsALk3v1&li_fat_id=li_fat_id_123456&msclkid=MSCLKID1234567890abcdef&rdt_cid=rdt_cid_abcdef123456&sc_click_id=sc_click_id_1234567890&ts=1718505600&ttclid=TTCLID1234567890abcdef&ttp=ttp_example_value&twclid=twclid_example_123456&uid=user_123456789&value=49.99&wbraid=WBRAIDabcdef1234567890&wk=abc123writekey789xyz") .header("X-Write-Key", "") .asString(); ``` ```php request('GET', 'https://api.example.com/pixel?aid=ad_987654321¤cy=USD&eid=evt_20240615_001&epik=epik_example_123456&event=purchase&fbc=fb.1.1680000000000.IwAR0Example&fbclid=IwAR0FbclidExample1234567890&fbp=fb.1.1680000000000.1234567890&format=json&gbraid=GBRAID1234567890abcdef&gclid=Cj0KCQjw8rOaBhD0ARIsALk3v1&li_fat_id=li_fat_id_123456&msclkid=MSCLKID1234567890abcdef&rdt_cid=rdt_cid_abcdef123456&sc_click_id=sc_click_id_1234567890&ts=1718505600&ttclid=TTCLID1234567890abcdef&ttp=ttp_example_value&twclid=twclid_example_123456&uid=user_123456789&value=49.99&wbraid=WBRAIDabcdef1234567890&wk=abc123writekey789xyz', [ 'headers' => [ 'X-Write-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.example.com/pixel?aid=ad_987654321¤cy=USD&eid=evt_20240615_001&epik=epik_example_123456&event=purchase&fbc=fb.1.1680000000000.IwAR0Example&fbclid=IwAR0FbclidExample1234567890&fbp=fb.1.1680000000000.1234567890&format=json&gbraid=GBRAID1234567890abcdef&gclid=Cj0KCQjw8rOaBhD0ARIsALk3v1&li_fat_id=li_fat_id_123456&msclkid=MSCLKID1234567890abcdef&rdt_cid=rdt_cid_abcdef123456&sc_click_id=sc_click_id_1234567890&ts=1718505600&ttclid=TTCLID1234567890abcdef&ttp=ttp_example_value&twclid=twclid_example_123456&uid=user_123456789&value=49.99&wbraid=WBRAIDabcdef1234567890&wk=abc123writekey789xyz"); var request = new RestRequest(Method.GET); request.AddHeader("X-Write-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["X-Write-Key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/pixel?aid=ad_987654321¤cy=USD&eid=evt_20240615_001&epik=epik_example_123456&event=purchase&fbc=fb.1.1680000000000.IwAR0Example&fbclid=IwAR0FbclidExample1234567890&fbp=fb.1.1680000000000.1234567890&format=json&gbraid=GBRAID1234567890abcdef&gclid=Cj0KCQjw8rOaBhD0ARIsALk3v1&li_fat_id=li_fat_id_123456&msclkid=MSCLKID1234567890abcdef&rdt_cid=rdt_cid_abcdef123456&sc_click_id=sc_click_id_1234567890&ts=1718505600&ttclid=TTCLID1234567890abcdef&ttp=ttp_example_value&twclid=twclid_example_123456&uid=user_123456789&value=49.99&wbraid=WBRAIDabcdef1234567890&wk=abc123writekey789xyz")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```