FairShare APIs (1.0)

The FairShare APIs provides documentation for FairShare tracking and analytics services

Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/fairshare_swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

FairShare

Operations

Creates a new fairshare_activity

Request

Bodyapplication/json
activity_typestringrequired
Example: "viewed_page"
visitor_tokenstringrequired
Example: "test_visitor_token"
trackable_typestring
Example: "FairShare::PageVisit"
trackable_tokenstring
Example: "test_token"
metadataobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/fairshare_swagger/api/v1/fairshare/activities \
  -H 'Content-Type: application/json' \
  -d '{
    "activity_type": "viewed_page",
    "visitor_token": "test_visitor_token",
    "trackable_type": "FairShare::PageVisit",
    "trackable_token": "test_token",
    "metadata": {
      "url": "https://example.com"
    }
  }'

Responses

Activity accepted for processing

Submits a chat message

Request

Bodyapplication/json
visitor_tokenstringrequired
Example: "HzjitJgRQNgLq9LZvTDNHyoj"
messagestringrequired
Example: "Hello, I need assistance."
contactobjectrequired
contact.​full_namestring
Example: "John Doe"
contact.​phonestring
Example: "+1-1234567890"
contact.​emailstring
Example: "test.dsl@gmail.com"
attributionobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/fairshare_swagger/api/v1/fairshare/chat \
  -H 'Content-Type: application/json' \
  -d '{
    "visitor_token": "HzjitJgRQNgLq9LZvTDNHyoj",
    "message": "Hello, I need assistance.",
    "contact": {
      "full_name": "John Doe",
      "phone": "+1-1234567890",
      "email": "test.dsl@gmail.com"
    },
    "attribution": {
      "id": 1,
      "share_guid": "credit01"
    }
  }'

Responses

Chat submitted successfully

Submits a popup

Request

Bodyapplication/json
visitor_tokenstringrequired
Example: "HzjitJgRQNgLq9LZvTDNHyoj"
popup_idintegerrequired
Example: 1
contactobjectrequired
contact.​full_namestring
Example: "John Doe"
contact.​phonestring
Example: "+1-1234567890"
contact.​emailstring
Example: "test@gmail.com"
attributionobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/fairshare_swagger/api/v1/fairshare/popup \
  -H 'Content-Type: application/json' \
  -d '{
    "visitor_token": "HzjitJgRQNgLq9LZvTDNHyoj",
    "popup_id": 1,
    "contact": {
      "full_name": "John Doe",
      "phone": "+1-1234567890",
      "email": "test@gmail.com"
    },
    "attribution": {
      "id": null,
      "share_guid": "share_guid_12345"
    }
  }'

Responses

Popup submitted successfully

Creates a new page visit

Request

Bodyapplication/json
fluid_vstringrequired
Example: "visitor_token_12345"
fluid_cstring
Example: "visitor_c_12345"
fingerprintstring
Example: "fingerprint123"
urlstringrequired
Example: "https://danphe.fluid.app/home/shop"
utm_paramsobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/fairshare_swagger/api/v1/fairshare/view \
  -H 'Content-Type: application/json' \
  -d '{
    "fluid_v": "visitor_token_12345",
    "fluid_c": "visitor_c_12345",
    "fingerprint": "fingerprint123",
    "url": "https://danphe.fluid.app/home/shop",
    "utm_params": {
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "spring_sale",
      "utm_term": "shoes",
      "utm_content": "banner_ad"
    }
  }'

Responses

PageVisit Created - Bot request

FairShare Order Journey

Operations