Initializing help system before first use

# Health check resources

Operation | Description
--- | ---
GET /api/health/mirror | Check the health of the mirror configuration
GET /api/health/tableau | Check the health of the Tableau configuration

# GET /api/health/mirror

Check the health of the mirror configuration

Provides detailed information about the current mirror configuration and the health of the configuration

## Responses

200 OK

  The health status of the mirror configuration

  Content-Type application/vnd.com.fico.xpress.insight.v2+json

    MirrorHealth

403 Forbidden

  Access denied

404 Not Found

  The mirror is not configured

  Content-Type application/vnd.com.fico.xpress.insight.v2+json

    ErrorResponse

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-404",
              "desc": "Not Found",
              "innerError": {
                  "code": "OPTI-Insight-Persistence-DocumentNotFound",
                  "desc": "Document not found",
                  "message": "Unable to find document"
              },
              "message": "Not Found",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

# GET /api/health/tableau

Check the health of the Tableau configuration

Provides detailed information about the current Tableau configuration and the health of the configuration

## Responses

200 OK

  The health status of the Tableau configuration

  Content-Type application/vnd.com.fico.xpress.insight.v2+json

    TableauHealth

# ErrorDetail: object

An error detail

### Properties

code: string

  The unique code for this error

  Example:

      "FICO_PLATFORM_VALIDATION_INVALID_VALUE"

desc: string

  A description of this error for client information, not intended for display to the end user

  Example:

      "Conflict"

message: string

  A message providing further information which may be displayed to the end user

  Example:

      "Conflict"

target: string

  An identifier to help the client locate the error. Typically a JSON property name.

timestamp: string (date-time)

  When the error was first detected

# ErrorResponse: object

An error response containing fault or error information

### Properties

error:

  The top level error

  OuterError

# InnerError: object

More specific error information

### Properties

code: string

  The unique code for this error

  Example:

      "FICO-Platform-Validation-FileTooLarge"

desc: string

  A description of this error for client information, not intended for display to the end user

  Example:

      "Attachment upload too large"

innerError:

  More specific error information

  InnerError
message: string

  A message providing further information which may be displayed to the end user

  Example:

      "Files larger than 300 MB cannot be uploaded as attachments."

# MirrorConfigurationHealth: object

Configuration details for display in health checks

### Properties

databaseUrl: string

  The configured mirror database connection string

  Example:

      "mariadb://localhost:3306"

maxIdleTime: integer (int32)

  The configured maximum time, in seconds, the data for a scenario will live before it is evicted

  Example:

      1209600

minTimeToLive: integer (int32)

  The configured minimum time, in seconds, the data for a scenario will live before being eligible for eviction

  Example:

      604800

targetCapacity: integer (int32)

  The mirror capacity the system will attempt to maintain

  Example:

      10000

username: string

  The configured database username

  Example:

      "username"

# MirrorHealth: object

Provides health check information relating to the mirror configuration

### Properties

configuration:

  Holds mirror configuration information

  MirrorConfigurationHealth
healthChecks: object

  A map of VisualizationHealthCheck objects detailing the health of the mirror configuration

  VisualizationHealthCheck
status: string , one of { PASS , WARN , FAIL , SKIPPED }

  The combined status for the mirror health checks.

  Example:

      "FAIL"

# OuterError: object

The top level error

### Properties

code: string , one of { FICO-Platform-Http-400 , FICO-Platform-Http-404 , FICO-Platform-Http-406 , FICO-Platform-Http-409 , FICO-Platform-Http-413 , FICO-Platform-Http-422 , FICO-Platform-Http-423 , FICO-Platform-Http-429 , FICO-Platform-Http-500 , FICO-Platform-Http-502 , FICO-Platform-Http-503 }

  The unique code for this error

  Example:

      "FICO-Platform-Http-409"

desc: string

  A description of this error for client information, not intended for display to the end user

  Example:

      "Conflict"

details: object[]

  Details about specific errors that led to this reported error

  Array of ErrorDetail
innerError:

  More specific error information

  InnerError
message: string

  A message providing further information which may be displayed to the end user

  Example:

      "Conflict"

parentId: string

  An OpenTracing parent-span ID

  Example:

      "0020000000000001"

spanId: string

  An OpenTracing span ID

  Example:

      "b2fb4a1d1a96d312"

timestamp: string (date-time)

  When the error was first detected

traceId: string

  An OpenTracing trace ID

  Example:

      "463ac35c9f6413ad48485a3953bb6125"

# TableauConfigurationHealth: object

Configuration details for display in health checks

### Properties

mirrorHost: string

  The configured mirror host. This is optional and may be null, in which case the host from the mirror url is used.

  Example:

      "my-mirror-host"

mirrorPort: integer (int32)

  The configured mirror host. This is optional and may be null, in which case the port from the mirror url is used.

  Example:

      3306

siteId: string

  The configured siteId

  Example:

      "a-site-id"

systemUser: string

  The user name of the Tableau system Insight will use to connect to Tableau

  Example:

      "tableau-username"

tableauUrl: string

  The configured Tableau server URL

  Example:

      "https://my-server-address.fico.com"

# TableauHealth: object

Provides health check information relating to the Tableau configuration

### Properties

configuration:

  Holds Tableau configuration information

  TableauConfigurationHealth
healthChecks: object

  A map of VisualizationHealthCheck objects detailing the health of the Tableau configuration

  VisualizationHealthCheck
status: string , one of { PASS , WARN , FAIL , SKIPPED }

  The combined status for the tableau health checks.

  Example:

      "FAIL"

# VisualizationHealthCheck: object

Holds health check details

### Properties

description: string

  Describes what this health check covers

  Example:

      "A health check to check the availability of something"

status: string , one of { PASS , WARN , FAIL , SKIPPED }

  The status of this health check. Whether it has passed, failed or was skipped due to failures recorded in other checks

  Example:

      "FAIL"

statusMessage: string

  Provides a detailed explanation of the status

  Example:

      "Could not connect: Connection refused"

Parent Topic Insight 5 REST API

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.