Pixel: Interaction Analytics Guide

The Pixel

Endpoint: https://www.findmine.com/api/v1/analytics/pixel

The pixel can be used by clients integrating with the FINDMINE API directly (clients going through the FINDMINE JavaScript API are already handled) to provide data to FINDMINE in order to analyze spending habits and preferences between looks. Query params are provided below - required ones in addition to optional ones, which are subject to a client's available resources.

Interaction Pixel

In addition to transaction data, the pixel endpoint can also be used to provide FINDMINE with data about how users interact with the Complete the Look module. The following are query params for the pixel endpoint when sending interaction data. Please note that these should be provided situationally based on the interaction, and the more provided the better.

Query params for the pixel actors

FINDMINE will provide [required]:

  • application: A unique identifier provided to the client at the start of the integration. This identifier is not an authorization secret - it is safe.

Client MUST provide:

  • fm_session_id: A first-party cookie that is generated by our JS module that will need to be passed back to us in the parameters. This cookie will be available to your server with the name _fmSession.

Client can provide (the more the better) [optional, but highly suggested]:

  • session_id: A unique id tied to an individual browsing session. (ex. a GUID stored in a short-lived cookie) This provides extremely useful granular data on spending behavior.
  • customer_id: A hash of a customer id corresponding to a logged in user on a client site. This provides the highest accuracy for analyzing user spending and determining style preferences.
  • visitor_id: A unique id representing the site visitor, cross-device if available. (ex. A hash of a customer IP address) This provides good long-term data to see a bigger picture of user spending and style preferences.
  • device_type: Type of device used (Accepted types: desktop, mobile)
  • device_id: ID of the specific device used (ex. iPhones: https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor)
  • device_user: A hash of a user's Google or Apple account

Query params for tracking an interaction

  • interaction: Field which specifies the type of interaction performed [param is required - values are customizable]
    Example values (client can use, ignore, and/or create new ones):
    • interaction=item_click: User clicked on an item image in the look
    • interaction=next_click: User clicked on the 'Next' button in the module to go to the next look
    • interaction=previous_click: User clicked on the 'Previous' button in the module to go to the previous look
    • Values can be defined upon discussion with FINDMINE
      ex. interaction=image_expand_click: User clicked on an 'Expand Item Image' button

Attributes of the item/set interacted with:

  • response_uuid: UUID which is in the Complete-The-Look response
  • item_id: FINDMINE item_id of the item interacted with (ex. LFK214) [required]
  • set_id: the FINDMINE set id of the set (look) interacted with [required]
  • set_item_ids: FINDMINE item_id of each item in the set (look) interacted with. The data for this is obtainable from the "set_items" field of the correponding set in the /api/v1/match/sets POST response. [optional]
  • size: size of the item interacted with, if applicable (ex. size=medium) [optional]

Example API calls

Example of a user clicking on an item in a FINDMINE set (look):

GET /api/v1/analytics/pixel?application=a1s2d3&interaction=item_click&customer_id=388828042&visitor_id=09052708493180843610149618767541206783&session_id=E50D8936CE55AE890B6AAA13567A7EB6E3&item_id=101409&set_id=5048&set_item_ids=705845,676023,708919,708411&fm_session_id=8edaaf04-019e-4019-b97e-3797368a6b0d&response_uuid=1aie39-932f-2930-blf1-12031029323ja

Example of a user clicking on the 'Next' button in a FINDMINE set (look):

GET /api/v1/analytics/pixel?application=a1s2d3&interaction=next_click&customer_id=388828042&visitor_id=09052708493180843610149618767541206783&session_id=E50D8936CE55AE890B6AAA13567A7EB6E3&set_id=5048&set_item_ids=705845,676023,708919,708411&fm_session_id=8edaaf04-019e-4019-b97e-3797368a6b0d

Integration of the pixel

This can be implemented as an image tag:

<img
  height="1"
  width="1"
  style="display:none"
  src="https://www.findmine.com/api/v1/analytics/pixel?application=a1s2d3&interaction=next_click&customer_id=388828042&visitor_id=09052708493180843610149618767541206783&session_id=E50D8936CE55AE890B6AAA13567A7EB6E3&set_id=5048&set_item_ids=705845,676023,708919,708411&fm_session_id=8edaaf04-019e-4019-b97e-3797368a6b0d&response_uuid=1aie39-932f-2930-blf1-12031029323ja"
/>

Responses

204: Successful submission (there will not be a response body)
400: The request was malformed
500: Something went wrong on our end

← Complete the Look API Guide