Pixel and store tracking must be enabled for your company. If you do not see SideShift Pixel under Ads → Settings → Integrations, contact SideShift.
Set up your sites
- Open Ads → Settings → Integrations, then Manage on SideShift Pixel. Add each site that a person goes through as a Website: the landing page, the sign-up page, and the checkout. Give each one its name and its public HTTPS domain. See SideShift Pixel.
-
Paste the script of each Website into the
<head>of its pages. See Install SideShift Pixel. Connect your consent manager: the script records nothing before the person gives consent. -
On the page that a person reaches after sign-up, tell SideShift who the person is, then send the event. Call
identifyfirst and wait for it, so that the event carries the person’s email hash:The?.makes the call do nothing when the script has not loaded or the person has not given consent. The script hashes the email in the browser. The raw email never leaves the browser. See Identify a shopper. - For an event that does not happen on one of your pages, send the event from your tool. See Send an event from a tool.
Event names from the script
track takes the event name as its first argument. SideShift makes the name lowercase and replaces spaces and hyphens with _. Webinar Attended becomes webinar_attended. The result must have 1 to 60 lowercase letters, digits, or _. SideShift does not record an event with another name. It also does not record the names comment, dm_sent, link_click, store_order, identify, consentwithdrawn, custom, and saleofdataoptin.
To give an event a value, pass value and currency in major units:
Send an event from a tool
Use the events endpoint when an event happens in a tool: a webinar platform, a course checkout, or a no-code automation. Authenticate with the API key of the Website that the event belongs to. The key starts withss_orders_. Keep it secret. A Shopify store’s key does not work here.
Download the OpenAPI specification for client generation.
Send
email or emailHash, not both. Send valueCents and currency together or not at all. A request with any other field returns 400. The body can have at most 64 KiB.
A raw email is the one difference from the Orders API. That endpoint takes hashes only. This endpoint takes a raw email because a webinar tool or an automation cannot hash it. SideShift hashes the email in memory and then drops it. It never stores or logs the raw email.
A visitorId of a visitor who withdrew consent, or whose data was erased, is ignored. The event is then kept with the email hash alone. When the request has no email, SideShift refuses it with 400.
Example
POST, the URL above, the header Authorization: Bearer YOUR_ORDERS_API_KEY, and a JSON body that maps the person’s email from the trigger and sets event to your event name.
Responses and retries
A successful response is HTTP200:
eventId for the same Website and event name returns the first event’s ID and writes nothing. Without eventId, each request writes a new event, so a retry can count a person twice. Send an eventId whenever your tool can retry.
How people are matched
A person on your landing page and the same person on your checkout use two domains. The script’s visitor ID is a cookie on one domain, so the two sites share no visitor. SideShift matches the person by the email hash instead. Whenidentify runs, or when an event carries an email or email hash, SideShift links the hash to the visitor. An event then counts the creator clicks of every visitor that the same hash is linked to, on any Website of your company. The same person is one person in the report, whatever the site.
A person who never gives an email, and never reaches an event that carries one, is known only by the visitor. Their later events on another domain cannot join their click.
The script’s consent rules apply. The script records a visit, an identity, and an event only after the person gives consent. When the person withdraws consent, SideShift removes the visitor’s identity links. An event that also has the person’s email stays, without the visitor. SideShift deletes an event that has only the visitor and no email. The events endpoint has no consent check of its own. Send events only for people whose consent you hold. To erase a person’s data, use Erase a shopper. An erasure request for a Website deletes the person’s events on that Website and removes the credit that came from their visits to it. The person’s events on another Website of your company stay until you send an erasure request for that Website too.
Creator links
A creator link is a URL to your site with the creator’sss code. The person opens your page and the script records the click. A creator’s link in bio and a link that SideChat sends open a SideShift address first. SideShift counts the visit or tap, then opens your page with the creator’s ss code. Each link must point to a page on one of your Websites.
- Bio link. The creator’s link in bio. There is one link for each creator and brand, with one URL for each platform. A click on it credits the creator, but it cannot name a post. See Link in bio.
- Post link. One link for each approved submission. SideShift makes it without a message.
- DM link. With SideChat on, the DM that the creator’s account sends carries a link code. The code is the link of the post that got the comment. When the comment’s post has no tracked link, the code is the creator’s bio link. SideShift adds the code to a link that you chose: the campaign link, or the link that you set for that creator. The link must be on a connected Website. A creator’s own referral link is sent as it is.
Link in bio
Link in bio is off for a campaign until you turn it on. When it is on, SideShift creates the creator’s link in bio for your brand when the creator’s contract becomes active. SideShift does not create a link for a campaign-manager campaign. SideShift also does not create a link when your brand has no products and no valid website. The link has the formapp.sideshift.app/b/{brand}/{creator}/{code}. The code names the platform: ig for Instagram, tt for TikTok, yt for YouTube, th for Threads, x for X, fb for Facebook, sc for Snapchat, and li for LinkedIn. The creator gets one URL for each platform that the contract or the campaign names. When they name no platform, the creator gets Instagram, TikTok, and YouTube URLs.
SideShift does not send the URLs in a chat message. The creator finds them in the campaign, in the Link in bio row of the campaign overview. The row shows one URL for each platform, with a copy button. When you turn on link in bio after a creator is approved, the creator sees the URLs the next time they open the campaign. A later contract with your brand keeps the same URLs, and the link then follows the newer contract. The link continues to work after the contract ends.
The link opens a SideShift page with your products. When you picked products for the link, the page shows only those products, in the order that you picked them. When you picked no products, the page shows the campaign’s products. When none of your picked products is on sale, the page also shows the campaign’s products. When the campaign has no products, the page shows your catalog. When you have no products, or you choose Website, the link opens your website. An unknown link returns a 404 page.
A tap on a product or on your site adds these parameters to the URL:
utm_source: the platform of the link, orsideshiftfor the link with no platform code.utm_medium:bio.utm_campaign: the campaign name as a slug.utm_content: the creator’s part of the link.
ss code. A store on www.example.com also covers a URL on example.com. Each platform’s link has its own code, so store sales show which bio an order came from.
To turn on link in bio when you create or edit a UGC or influencer campaign, go to the Requirements step. Under Creator accounts, turn on Send creators a link in bio. In Link opens, select Products or Website. For Website, SideShift fills in your company website. You can enter another URL.
To change the setting of an existing campaign, open the campaign’s Edit menu and select Link in bio. Select Products or Website. For Products, select the products that the page shows. A number on each selected product shows its place on the page. You can search for a product by name. The page shows up to 48 products. For Website, enter a URL. SideShift refuses social network and SideShift addresses. Select Save. When link in bio is off for the campaign, Save turns it on. When you switch to Website, SideShift keeps your product selection for a later switch back to Products.
To turn off link in bio, edit the campaign and turn off Send creators a link in bio in the Requirements step. SideShift then does not create new links for the campaign, and the campaign no longer shows the links to creators. Links that creators already put in their bios continue to work.
The campaign’s creators table shows a Bio link clicks column. It counts the human visits to each creator’s link in bio. SideShift counts a visit once for each visitor, hour, and platform. SideShift does not count link-preview fetches.
Read the Attribution page
Open Analytics → Attribution. With no Website, the page asks you to connect one.Pick dates, filters and a result
Use the date filter to set the range. Select Filters to open the filter panel. Use the filters to count only some creator links. You can pick more than one item in each filter, except Post Type: you pick one type. When you use two filters, a link must match both. The number on Filters is the number of items that you picked. Select Clear Filters to remove all of them.
A bio link, and a SideChat link with no post, have no post. They do not show when you pick a post type or a post tag. A bio link also does not show when you pick a platform. A SideChat link with no post shows only when you pick the platform of the first DM that sent it. A SideChat link that no DM sent yet counts as Instagram. The Product, Brief, and Creator Tags filters show only when your company has products on submissions, briefs with picks, or creator tags.
With a filter on, the counts, the value, and each creator’s share are of the links that the filter keeps. Views shows the views of the creator’s posts that match the campaigns, platforms, post tags and post type that you pick. With a product or a brief picked, it shows the views of the posts of the links that the filter keeps. The filters stay in the page address, so a link to the page opens with the same filters.
The table ranks creators by a result:
When your Websites sent no event of their own, the result is Store order and the filter panel has no Result section. When they sent events, select Filters and pick one result in the Result section. Clear Filters does not change the result. The page opens on Store order if your store has orders. Else it opens on the event that your sites sent most often.
The page has no model or window picker. It credits each person with your saved default model and window. The default is Last non-direct click with a 7-day window. Under this default, the credit goes to the last creator link, or other non-direct visit, that the person made before the result and inside 7 days.
The table
The table has one row for each creator, ranked by the result. Select a column header to sort. Select a creator to see their posts, one row for each post link, the bio link rows, and the SideChat rows. Each platform’s link in bio has its own row, for example Bio link · Instagram.
When no creator brought anyone in the date range, the page shows No activity in this range. With a filter on, it shows No activity for these filters.
Export the table
Select Export to download the table as a CSV file. The file has the result, the date range and the filters that are on the page. It has one row for each creator, and one row for each post, SideChat and bio link row of that creator. The columns are Creator, Row (the kind of row), Name, Post URL, and the columns of the table. Value and Currency are in the file only when the result has a value. Export shows only to team members who can see financial data.How SideShift counts
A count is a number of people. A person counts once, by the first event of the result that the person sent in the date range. A person is the email hash. An event with no email hash takes the email hash of its visitor: the hash of another event of that visitor, or the hash thatidentify linked to the visitor. So an event sent before identify and an event sent after it are one person. A visitor linked to two or more email hashes, such as a shared device, stays a person of its own. A visitor with no email hash is a person of its own.
- Link click counts people. A visitor linked to an email hash is that person, so a person who clicked on a phone and on a laptop counts once. A person counts once on a row, also when the person clicked more than one link of that row.
- Store order counts buyers, not orders. A buyer is the email hash of the order. An order with no email hash takes the email hash of the other orders of the same customer ID in that store, when those orders have one email hash. Else the buyer is the store’s customer ID. A buyer with two orders in the range counts once, by the first order. An order with no buyer identity counts as one person.
- When your company has no event of the result in the date range, the result shows a dash. When it has events, a creator with none shows 0.
- Value is the sum of the credited value of all events of the result in the date range: every order and every event with a value, not only the first event of each person. When all the values have one currency, Value shows that currency. When they have more than one, SideShift converts each value to USD.