Swallow
  • YOUR FIRST MODEL
    • Setting up your first project
    • Manual setup of a new product
    • Excel Model Upload
    • Create your team
    • Essential concepts
      • Syntax
      • Steps
      • Collections
      • Try Model
      • Spotlight
  • PROCESS
    • Team Management
    • Governance & Collaboration
  • BUILD
    • Building with AI
    • Step builder
      • Understanding step types
      • Ordering step blocks
      • Placeholder mode
      • Up/Downloading models
      • Sharing your model
      • Running tests
    • Inputs
    • Enriching Raw Data
      • Transform Data
      • Enrich via API
      • Data Set
      • Collection
      • Custom Code
    • Setting Up Decisions
      • Exclusions
      • Excesses
      • Endorsements
      • Refer
    • Making Calculations
      • Factors
      • Calculation
    • Outputs
  • TEST
    • Creating New Tests
    • Running Tests
    • Editing Tests
    • Reading & Interpreting Tests
    • Impact Testing
  • DATA
    • Working with real-time data
    • Data Views
    • Data Quotas
    • Troubleshooting
    • API Webhooks
    • Data Downloads
  • ADMIN & SETTINGS
    • Project Management
    • Account Management
  • INTEGRATIONS
    • Introduction
    • Payments
      • Stripe
      • GoCardless
      • Adyen
    • Alerting
      • Slack
      • Zapier
    • Data
      • AWS S3
      • Google Sheets
    • Admin
      • Socotra
      • Guidewire
      • Hubspot
      • Salesforce
  • Developer API
    • Introduction
    • Authentication
    • Errors codes
    • Endpoints
      • /quotes
      • /projects
      • /tests
      • /process
Powered by GitBook
On this page
  1. Developer API
  2. Endpoints

/projects

Projects API is for reporting on pricing project states and to aid in building custom quote flows

Previous/quotesNext/tests

Last updated 1 year ago

Retrieve all projects

This will retrieve all projects within your account. It will show the latest published version along with other useful project details.

Retrieve a specific project

This will show a specific project with the latest published version, all versions to date and their status.

Each project has a unique project_reference and each version has a unique version_reference.

Retrieve all project versions

Project versions can be returned in bulk or filtered via the summary change log (using ?summary)

https://api.llow.io/sw/projects/versions?summary=search%20term

or via project_reference

https://api.llow.io/sw/projects/versions?project_reference=56c575d2-b6b9-44ed-9c75-5d705b987ec1

Help building your own quote flows

The public project endpoint will return all the input parameters needed for a Swallow pricing project and all the lists of data options (generated by factor table data). This allows you to build custom and validated custom quote flows.

The quote flows can be programmatic (aggregator integrations) or via custom build user interfaces (within an app or website).

This is a public API endpoint. You can hit this endpoint for client-side code by just providing client_id_key in the header. View to find out more. Public APIs have /public/ within the endpoint url.

authentication

Return all pricing project versions

get
Query parameters
project_referencestringOptional

Project reference. It is a UUID.

Example: 56c575d2-b6b9-44ed-9c75-5d705b987ec1
statusstringOptional

Pricing project published status. It can be in draft, approved, published or subsequently unpublished

Example: draft
Responses
200
/sw/projects response
application/json
get
GET /sw/projects HTTP/1.1
Host: api.llow.io
Accept: */*
200

/sw/projects response

{
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "name": "Monthly motor insurance product",
  "description": "Monthly motor insurance product for the UK market",
  "summary": "<p>Example change log of version</p>",
  "version": 1,
  "status": "draft",
  "size": 8.6,
  "disabled": false,
  "approved_at": "2021-04-22T14:29:22.000Z",
  "published_at": "2021-04-22T14:29:22.000Z",
  "updated_at": "2021-04-22T14:29:22.000Z",
  "created_at": "2021-03-22T14:29:22.000Z",
  "versions": [
    {}
  ]
}

Return the latest pricing project

get
Path parameters
project_referencestringRequired

Project reference. It is a UUID.

Example: 56c575d2-b6b9-44ed-9c75-5d705b987ec1
Query parameters
statusstringOptional

Pricing project published status. It can be in draft, approved, published or subsequently unpublished

Example: draft
version_referencestringOptional

Project version reference. It is a UUID.

Example: 46c575d2-b6b9-44ed-9c75-5d705b987ec1
Responses
200
/sw/projects/{project_reference} response
application/json
get
GET /sw/projects/{project_reference} HTTP/1.1
Host: api.llow.io
Accept: */*
200

/sw/projects/{project_reference} response

{
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "name": "Monthly motor insurance product",
  "description": "Monthly motor insurance product for the UK market",
  "summary": "<p>Example change log of version</p>",
  "version": 1,
  "status": "draft",
  "size": 8.6,
  "disabled": false,
  "approved_at": "2021-04-22T14:29:22.000Z",
  "published_at": "2021-04-22T14:29:22.000Z",
  "updated_at": "2021-04-22T14:29:22.000Z",
  "created_at": "2021-03-22T14:29:22.000Z",
  "versions": [
    {}
  ]
}

Return all pricing project versions

get
Query parameters
project_referencestringOptional

Project reference. It is a UUID.

Example: 56c575d2-b6b9-44ed-9c75-5d705b987ec1
version_referencestringOptional

Project version reference. It is a UUID.

Example: 46c575d2-b6b9-44ed-9c75-5d705b987ec1
summarystringOptional

A html formatted change log of a project version.

Example: <p>Example change log of version</p>
Responses
200
/sw/projects/versions response
application/json
get
GET /sw/projects/versions HTTP/1.1
Host: api.llow.io
Accept: */*
200

/sw/projects/versions response

{
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "name": "Monthly motor insurance product",
  "description": "Monthly motor insurance product for the UK market",
  "summary": "<p>Example change log of version</p>",
  "version": 1,
  "status": "draft",
  "size": 8.6,
  "disabled": false,
  "approved_at": "2021-04-22T14:29:22.000Z",
  "published_at": "2021-04-22T14:29:22.000Z",
  "updated_at": "2021-04-22T14:29:22.000Z",
  "created_at": "2021-03-22T14:29:22.000Z"
}

Returns public project details to build custom form

get
Path parameters
project_referencestringRequired

Project reference. It is a UUID.

Example: 56c575d2-b6b9-44ed-9c75-5d705b987ec1
Responses
200
/sw/public/projects/{project_reference} response
application/json
get
GET /sw/public/projects/{project_reference} HTTP/1.1
Host: api.llow.io
Accept: */*
200

/sw/public/projects/{project_reference} response

{
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version": 1,
  "updated_at": "2021-04-22T14:29:22.000Z",
  "inputs": {
    "bike_type": {
      "type": "string",
      "label": "Your bike type",
      "def": "Road"
    }
  },
  "lists": {
    "bike_type": {
      "type": "string",
      "data": [
        "Road",
        "Mountain",
        "BMX"
      ]
    }
  }
}
  • GETReturn all pricing project versions
  • GETReturn the latest pricing project
  • GETReturn all pricing project versions
  • GETReturns public project details to build custom form