Update a Lighthouse scan

Fluid Company APIs (1.0)

The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.

For APIs that authenticate with User tokens, see the Rep APIs documentation. For public SDK APIs, see the Public SDK APIs documentation.

Download OpenAPI description

company.api.json

company.api.yaml

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/

Production server with company subdomain

https://{company}.fluid.app/

Local development server

http://fluid.lvh.me:{port}/

Activities

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

Application Theme Resources

Operations

Application Theme Templates

Operations

Application Themes

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Compliance

Content compliance scanning endpoints for products, media, playlists, categories, collections, posts, and enrollment packs

Operations

Contacts

Operations

Conversations

Operations

Countries

Operations

Currencies

Operations

Custom Pages

Operations

Customer Notes

Operations

Customer Orders

Operations

Customers

Operations

DAM

Digital Asset Management endpoints

Operations

Default Libraries

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

Events

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

Global Embeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

Lighthouse

Lighthouse performance scanning endpoints for products, media, playlists, categories, collections, posts, and enrollment packs

Operations

Get latest Lighthouse scan for a product

Request

Returns the most recent Lighthouse performance scan for a product

Path

product_idintegerrequired

Product ID

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/v202506/products/{product_id}/lighthouse' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

latest Lighthouse scan found

Bodyapplication/json

itemobjectrequired

item.idintegerrequired

Example: 1

item.scanned_atstring(date-time)required

item.device_typestring or null

Enum"mobile""desktop"

Example: "mobile"

item.final_urlstring or null

Example: "https://example.com/product"

item.fetch_timestring or null(date-time)

item.created_atstring(date-time)

item.updated_atstring(date-time)

item.core_metricsobject

item.category_scoresobject

Example: {"performance":85,"accessibility":92,"best-practices":88,"seo":95}

item.optimization_opportunitiesArray of objects

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "item": {
    "id": 1,
    "scanned_at": "2019-08-24T14:15:22Z",
    "device_type": "mobile",
    "final_url": "https://example.com/product",
    "fetch_time": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "core_metrics": { … },
    "category_scores": { … },
    "optimization_opportunities": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

List all Lighthouse scans for a product

Request

Returns a paginated list of all Lighthouse scans for a product

Path

product_idintegerrequired

Product ID

Query

pageinteger

Page number

per_pageinteger

Items per page

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/v202506/products/{product_id}/lighthouses?page=0&per_page=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Lighthouse scans retrieved

Bodyapplication/json

itemsArray of objectsrequired

items[].idintegerrequired

Example: 1

items[].scanned_atstring(date-time)required

items[].device_typestring or null

Enum"mobile""desktop"

Example: "mobile"

items[].final_urlstring or null

Example: "https://example.com/product"

items[].fetch_timestring or null(date-time)

items[].created_atstring(date-time)

items[].updated_atstring(date-time)

items[].core_metricsobject

items[].category_scoresobject

Example: {"performance":85,"accessibility":92,"best-practices":88,"seo":95}

items[].optimization_opportunitiesArray of objects

paginationobjectrequired

pagination.current_pageinteger

pagination.total_pagesinteger

pagination.total_countinteger

pagination.per_pageinteger

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "items": [
    { … }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_count": 0,
    "per_page": 0
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Create a new Lighthouse scan

Request

Creates a new Lighthouse performance scan record for a product

Path

product_idintegerrequired

Product ID

Bodyapplication/json

lighthouseobjectrequired

lighthouse.scanned_atstring(date-time)required

Example: "2026-01-12T10:00:00Z"

lighthouse.resultobjectrequired

Full Lighthouse API response from Google PageSpeed Insights

Example: {"lighthouseResult":{"finalUrl":"https://example.com/product","categories":{"performance":{"score":0.85}}}}

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/v202506/products/{product_id}/lighthouses' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "lighthouse": {
      "scanned_at": "2026-01-12T10:00:00Z",
      "result": {
        "lighthouseResult": {
          "finalUrl": "https://example.com/product",
          "categories": {
            "performance": {
              "score": 0.85
            }
          }
        }
      }
    }
  }'

Responses

Lighthouse scan created

Bodyapplication/json

itemobjectrequired

item.idintegerrequired

Example: 1

item.scanned_atstring(date-time)required

item.device_typestring or null

Enum"mobile""desktop"

Example: "mobile"

item.final_urlstring or null

Example: "https://example.com/product"

item.fetch_timestring or null(date-time)

item.created_atstring(date-time)

item.updated_atstring(date-time)

item.core_metricsobject

item.category_scoresobject

Example: {"performance":85,"accessibility":92,"best-practices":88,"seo":95}

item.optimization_opportunitiesArray of objects

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "item": {
    "id": 1,
    "scanned_at": "2019-08-24T14:15:22Z",
    "device_type": "mobile",
    "final_url": "https://example.com/product",
    "fetch_time": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "core_metrics": { … },
    "category_scores": { … },
    "optimization_opportunities": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get a specific Lighthouse scan

Request

Returns details of a specific Lighthouse scan with full result data

Path

product_idintegerrequired

Product ID

idintegerrequired

Lighthouse ID

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/v202506/products/{product_id}/lighthouses/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Lighthouse scan found

Bodyapplication/json

itemobjectrequired

item.idintegerrequired

Example: 1

item.scanned_atstring(date-time)required

item.device_typestring or null

Enum"mobile""desktop"

Example: "mobile"

item.final_urlstring or null

Example: "https://example.com/product"

item.fetch_timestring or null(date-time)

item.created_atstring(date-time)

item.updated_atstring(date-time)

item.core_metricsobject

item.category_scoresobject

Example: {"performance":85,"accessibility":92,"best-practices":88,"seo":95}

item.optimization_opportunitiesArray of objects

item.resultobject

Full Lighthouse API response JSON

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "item": {
    "id": 1,
    "scanned_at": "2019-08-24T14:15:22Z",
    "device_type": "mobile",
    "final_url": "https://example.com/product",
    "fetch_time": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "core_metrics": { … },
    "category_scores": { … },
    "optimization_opportunities": [ … ],
    "result": {}
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a Lighthouse scan

Request

Updates an existing Lighthouse scan

Path

product_idintegerrequired

Product ID

idintegerrequired

Lighthouse ID

Bodyapplication/json

lighthouseobjectrequired

lighthouse.scanned_atstring(date-time)

lighthouse.resultobject

curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/v202506/products/{product_id}/lighthouses/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "lighthouse": {
      "scanned_at": "2019-08-24T14:15:22Z",
      "result": {}
    }
  }'

Responses

Lighthouse scan updated

Bodyapplication/json

itemobjectrequired

item.idintegerrequired

Example: 1

item.scanned_atstring(date-time)required

item.device_typestring or null

Enum"mobile""desktop"

Example: "mobile"

item.final_urlstring or null

Example: "https://example.com/product"

item.fetch_timestring or null(date-time)

item.created_atstring(date-time)

item.updated_atstring(date-time)

item.core_metricsobject

item.category_scoresobject

Example: {"performance":85,"accessibility":92,"best-practices":88,"seo":95}

item.optimization_opportunitiesArray of objects

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "item": {
    "id": 1,
    "scanned_at": "2019-08-24T14:15:22Z",
    "device_type": "mobile",
    "final_url": "https://example.com/product",
    "fetch_time": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "core_metrics": { … },
    "category_scores": { … },
    "optimization_opportunities": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a Lighthouse scan

Request

Deletes a Lighthouse scan record

Path

product_idintegerrequired

Product ID

idintegerrequired

Lighthouse ID

curl -i -X DELETE \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/v202506/products/{product_id}/lighthouses/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Lighthouse scan deleted

Bodyapplication/json

messagestring

metaobject

Response

application/json

{
  "message": "string",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

MCC Codes

Operations

Media

Operations

Menus

Operations

Messages

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Points

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Product Bundles

Operations

Product Images

Operations

Product Redirects

Operations

Product Subscription Plans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Recipients

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shop

Operations

Sitemap

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tiles

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variant Images

Operations

Variant Inventory Levels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations

Fluid Company APIs (1.0)

Activities

Admins

Agreements

Announcements

Application Theme Resources

Application Theme Templates

Application Themes

Authentication

Bank Accounts

Brand Guidelines

Business Types

Callback Definitions

Callback Registrations

Callback Schemas

Carts

Catch Ups

Categories

Checkout

Collections

Companies

Company Countries

Compliance

Contacts

Conversations

Countries

Currencies

Custom Pages

Customer Notes

Customer Orders

Customers

DAM

Default Libraries

Devices

Discounts

Display Settings

Domains

Drop Zones

Droplet Categories

Droplet Installations

Droplets

Enrollment Packs

Enrollments

Entities

Events

Fantasy Points

Feature Flags

File Resources

Fluid Pay

Form Elements

Forms

Global Embeds

Impersonation

Inventory Levels

Labels

Languages

Libraries

Lighthouse

Get latest Lighthouse scan for a product

Request

Responses

Was this helpful?

List all Lighthouse scans for a product

Request

Responses

Was this helpful?

Create a new Lighthouse scan

RequestExpand all

Responses

Was this helpful?

Get a specific Lighthouse scan

Request

Responses

Was this helpful?

Update a Lighthouse scan

RequestExpand all

Responses

Was this helpful?

Delete a Lighthouse scan

Request

Request

Request