NIC MAP Developer Portal

NIC MAP Client API

Endpointhttps://api.nicmap.com

Create Analysis

POST

https://api.nicmap.com

/api/v1/ClientAnalysis/create

Create Analysis › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create Analysis › Request Body

bufferType

string · enum · required

Enum values:

Distance

DriveTime

bufferValue

integer · int32 · required

address

string

latitude

number · double

longitude

number · double

analysisName

string

Create Analysis › Responses

Success

success

boolean · required

analysisId

integer · int32

errorMessage

string

POST/api/v1/ClientAnalysis/create

curl --request POST \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/create \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "address",
  "latitude": 0,
  "longitude": 0,
  "bufferType": "Distance",
  "bufferValue": 0,
  "analysisName": "analysisName"
}
'

shell

Example Request Body

{
  "address": "address",
  "latitude": 0,
  "longitude": 0,
  "bufferType": "Distance",
  "bufferValue": 0,
  "analysisName": "analysisName"
}

json

Example Responses

{
  "success": true,
  "analysisId": 0,
  "errorMessage": "errorMessage"
}

json

application/json

Get Analysis Status

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/status/{analysisId}

Get Analysis Status › path Parameters

analysisId

integer · int32 · required

Get Analysis Status › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Analysis Status › Responses

Success

analysisId

integer · int32 · required

dateRequested

string · date-time · required

status

string

percentComplete

number · double

dateCompleted

string · date-time

name

string

GET/api/v1/ClientAnalysis/status/{analysisId}

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/status/:analysisId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "status": "status",
  "percentComplete": 0,
  "dateRequested": "2024-08-25T15:00:00Z",
  "dateCompleted": "2024-08-25T15:00:00Z",
  "name": "name"
}

json

application/json

Get Quota

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/quota

Get Quota › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Quota › Responses

Success

dailyLimit

integer · int32 · required

usedToday

integer · int32 · required

remaining

integer · int32 · required

GET/api/v1/ClientAnalysis/quota

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/quota \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "dailyLimit": 0,
  "usedToday": 0,
  "remaining": 0
}

json

application/json

Get Metrics

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/metrics

Get Metrics › path Parameters

analysisId

integer · int32 · required

Get Metrics › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Metrics › Responses

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

bufferTypeId

integer · int32

bufferValue

number · double

object[]

GET/api/v1/ClientAnalysis/{analysisId}/metrics

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/metrics \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "bufferTypeId": 0,
  "bufferValue": 0,
  "metrics": [
    {
      "measureTypeId": 0,
      "name": "name",
      "displayName": "displayName",
      "value": 0,
      "displayType": "displayType",
      "formattedValue": "formattedValue"
    }
  ]
}

json

application/json

Get Supply

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/supply

Get Supply › path Parameters

analysisId

integer · int32 · required

Get Supply › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Supply › Responses

200

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

bufferTypeId

integer · int32

bufferValue

number · double

object[]

GET/api/v1/ClientAnalysis/{analysisId}/supply

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/supply \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "bufferTypeId": 0,
  "bufferValue": 0,
  "supply": [
    {
      "id": "id",
      "name": "name",
      "address": "address",
      "city": "city",
      "state": "state",
      "zip": "zip",
      "latitude": 0,
      "longitude": 0,
      "distanceFromTarget": 0,
      "yearOpened": 0,
      "supplyType": 0,
      "totalUnits": 0,
      "propertyType": "propertyType",
      "propertyStatus": "propertyStatus"
    }
  ]
}

json

application/json

Get Dodge Pipeline

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/pipeline/dodge

Get Dodge Pipeline › path Parameters

analysisId

integer · int32 · required

Get Dodge Pipeline › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Dodge Pipeline › Responses

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

object[]

GET/api/v1/ClientAnalysis/{analysisId}/pipeline/dodge

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/pipeline/dodge \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "projects": [
    {
      "name": "name",
      "latitude": 0,
      "longitude": 0,
      "distanceFromTarget": 0,
      "isTypeNewConstruction": true,
      "isTypeAddition": true,
      "isTypeAlteration": true,
      "isTypeConversion": true,
      "stage": "stage",
      "targetConstCompletion": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get BuildCentral Pipeline

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/pipeline/buildcentral

Get BuildCentral Pipeline › path Parameters

analysisId

integer · int32 · required

Get BuildCentral Pipeline › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get BuildCentral Pipeline › Responses

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

object[]

GET/api/v1/ClientAnalysis/{analysisId}/pipeline/buildcentral

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/pipeline/buildcentral \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "projects": [
    {
      "name": "name",
      "latitude": 0,
      "longitude": 0,
      "distanceFromTarget": 0,
      "isTypeNewConstruction": true,
      "isTypeAddition": true,
      "isTypeAlteration": true,
      "isTypeConversion": true,
      "stage": "stage",
      "targetConstCompletion": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get Facilities

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities

Get Facilities › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Facilities › Responses

Success

object[]

GET/api/v1/ClientResidentInsight/facilities

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilities": [
    {
      "facilityId": 0,
      "communityName": "communityName"
    }
  ]
}

json

application/json

Get Runs For Facility

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs

Get Runs For Facility › path Parameters

facilityId

integer · int32 · required

Get Runs For Facility › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Runs For Facility › Responses

Success

facilityId

integer · int32 · required

object[]

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runs": [
    {
      "runId": 0,
      "runDate": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get Benchmark Facilities

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmarks

Get Benchmark Facilities › path Parameters

facilityId

integer · int32 · required

runId

integer · int32 · required

Get Benchmark Facilities › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Benchmark Facilities › Responses

Success

facilityId

integer · int32 · required

runId

integer · int32 · required

object[]

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmarks

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs/:runId/benchmarks \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runId": 0,
  "benchmarkFacilities": [
    {
      "facilityId": 0,
      "communityName": "communityName"
    }
  ]
}

json

application/json

Get Insight Data

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}

Get Insight Data › path Parameters

facilityId

integer · int32 · required

runId

integer · int32 · required

Get Insight Data › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Insight Data › Responses

Success

facilityId

integer · int32 · required

runId

integer · int32 · required

benchmarkFacilityId

integer · int32

object[]

object

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs/:runId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runId": 0,
  "benchmarkFacilityId": 0,
  "wealth": [
    {
      "type": 0,
      "selection": [
        {
          "label": "label",
          "dataPoints": [
            {
              "label": "label",
              "value": 0,
              "benchmark": 0,
              "bottom": 0
            }
          ]
        }
      ]
    }
  ],
  "stats": {
    "totalRecords": 0,
    "matchedRecords": 0,
    "matchRate": 0
  }
}

json

application/json

Get Insight Data With Benchmark

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmark/{benchmarkFacilityId}

Get Insight Data With Benchmark › path Parameters

facilityId

integer · int32 · required

runId

integer · int32 · required

benchmarkFacilityId

integer · int32 · required

Get Insight Data With Benchmark › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Insight Data With Benchmark › Responses

Success

facilityId

integer · int32 · required

runId

integer · int32 · required

benchmarkFacilityId

integer · int32

object[]

object

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmark/{benchmarkFacilityId}

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs/:runId/benchmark/:benchmarkFacilityId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runId": 0,
  "benchmarkFacilityId": 0,
  "wealth": [
    {
      "type": 0,
      "selection": [
        {
          "label": "label",
          "dataPoints": [
            {
              "label": "label",
              "value": 0,
              "benchmark": 0,
              "bottom": 0
            }
          ]
        }
      ]
    }
  ],
  "stats": {
    "totalRecords": 0,
    "matchedRecords": 0,
    "matchRate": 0
  }
}

json

application/json

Get Mosaic Definitions

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/mosaic-definitions

Get Mosaic Definitions › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Mosaic Definitions › Responses

Success

object[]

GET/api/v1/ClientResidentInsight/mosaic-definitions

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/mosaic-definitions \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "definitions": [
    {
      "label": "label",
      "title": "title",
      "description": "description"
    }
  ]
}

json

application/json

NIC MAP Client API

Endpointhttps://api.nicmap.com

Create Analysis

POST

https://api.nicmap.com

/api/v1/ClientAnalysis/create

Create Analysis › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create Analysis › Request Body

bufferType

string · enum · required

Enum values:

Distance

DriveTime

bufferValue

integer · int32 · required

address

string

latitude

number · double

longitude

number · double

analysisName

string

Create Analysis › Responses

Success

success

boolean · required

analysisId

integer · int32

errorMessage

string

POST/api/v1/ClientAnalysis/create

curl --request POST \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/create \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "address",
  "latitude": 0,
  "longitude": 0,
  "bufferType": "Distance",
  "bufferValue": 0,
  "analysisName": "analysisName"
}
'

shell

Example Request Body

{
  "address": "address",
  "latitude": 0,
  "longitude": 0,
  "bufferType": "Distance",
  "bufferValue": 0,
  "analysisName": "analysisName"
}

json

Example Responses

{
  "success": true,
  "analysisId": 0,
  "errorMessage": "errorMessage"
}

json

application/json

Get Analysis Status

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/status/{analysisId}

Get Analysis Status › path Parameters

analysisId

integer · int32 · required

Get Analysis Status › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Analysis Status › Responses

Success

analysisId

integer · int32 · required

dateRequested

string · date-time · required

status

string

percentComplete

number · double

dateCompleted

string · date-time

name

string

GET/api/v1/ClientAnalysis/status/{analysisId}

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/status/:analysisId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "status": "status",
  "percentComplete": 0,
  "dateRequested": "2024-08-25T15:00:00Z",
  "dateCompleted": "2024-08-25T15:00:00Z",
  "name": "name"
}

json

application/json

Get Quota

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/quota

Get Quota › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Quota › Responses

Success

dailyLimit

integer · int32 · required

usedToday

integer · int32 · required

remaining

integer · int32 · required

GET/api/v1/ClientAnalysis/quota

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/quota \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "dailyLimit": 0,
  "usedToday": 0,
  "remaining": 0
}

json

application/json

Get Metrics

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/metrics

Get Metrics › path Parameters

analysisId

integer · int32 · required

Get Metrics › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Metrics › Responses

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

bufferTypeId

integer · int32

bufferValue

number · double

object[]

GET/api/v1/ClientAnalysis/{analysisId}/metrics

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/metrics \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "bufferTypeId": 0,
  "bufferValue": 0,
  "metrics": [
    {
      "measureTypeId": 0,
      "name": "name",
      "displayName": "displayName",
      "value": 0,
      "displayType": "displayType",
      "formattedValue": "formattedValue"
    }
  ]
}

json

application/json

Get Supply

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/supply

Get Supply › path Parameters

analysisId

integer · int32 · required

Get Supply › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Supply › Responses

200

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

bufferTypeId

integer · int32

bufferValue

number · double

object[]

GET/api/v1/ClientAnalysis/{analysisId}/supply

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/supply \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "bufferTypeId": 0,
  "bufferValue": 0,
  "supply": [
    {
      "id": "id",
      "name": "name",
      "address": "address",
      "city": "city",
      "state": "state",
      "zip": "zip",
      "latitude": 0,
      "longitude": 0,
      "distanceFromTarget": 0,
      "yearOpened": 0,
      "supplyType": 0,
      "totalUnits": 0,
      "propertyType": "propertyType",
      "propertyStatus": "propertyStatus"
    }
  ]
}

json

application/json

Get Dodge Pipeline

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/pipeline/dodge

Get Dodge Pipeline › path Parameters

analysisId

integer · int32 · required

Get Dodge Pipeline › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Dodge Pipeline › Responses

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

object[]

GET/api/v1/ClientAnalysis/{analysisId}/pipeline/dodge

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/pipeline/dodge \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "projects": [
    {
      "name": "name",
      "latitude": 0,
      "longitude": 0,
      "distanceFromTarget": 0,
      "isTypeNewConstruction": true,
      "isTypeAddition": true,
      "isTypeAlteration": true,
      "isTypeConversion": true,
      "stage": "stage",
      "targetConstCompletion": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get BuildCentral Pipeline

GET

https://api.nicmap.com

/api/v1/ClientAnalysis/{analysisId}/pipeline/buildcentral

Get BuildCentral Pipeline › path Parameters

analysisId

integer · int32 · required

Get BuildCentral Pipeline › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get BuildCentral Pipeline › Responses

Success

analysisId

integer · int32 · required

siteId

integer · int32 · required

object[]

GET/api/v1/ClientAnalysis/{analysisId}/pipeline/buildcentral

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientAnalysis/:analysisId/pipeline/buildcentral \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "analysisId": 0,
  "siteId": 0,
  "projects": [
    {
      "name": "name",
      "latitude": 0,
      "longitude": 0,
      "distanceFromTarget": 0,
      "isTypeNewConstruction": true,
      "isTypeAddition": true,
      "isTypeAlteration": true,
      "isTypeConversion": true,
      "stage": "stage",
      "targetConstCompletion": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get Facilities

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities

Get Facilities › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Facilities › Responses

Success

object[]

GET/api/v1/ClientResidentInsight/facilities

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilities": [
    {
      "facilityId": 0,
      "communityName": "communityName"
    }
  ]
}

json

application/json

Get Runs For Facility

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs

Get Runs For Facility › path Parameters

facilityId

integer · int32 · required

Get Runs For Facility › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Runs For Facility › Responses

Success

facilityId

integer · int32 · required

object[]

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runs": [
    {
      "runId": 0,
      "runDate": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get Benchmark Facilities

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmarks

Get Benchmark Facilities › path Parameters

facilityId

integer · int32 · required

runId

integer · int32 · required

Get Benchmark Facilities › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Benchmark Facilities › Responses

Success

facilityId

integer · int32 · required

runId

integer · int32 · required

object[]

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmarks

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs/:runId/benchmarks \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runId": 0,
  "benchmarkFacilities": [
    {
      "facilityId": 0,
      "communityName": "communityName"
    }
  ]
}

json

application/json

Get Insight Data

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}

Get Insight Data › path Parameters

facilityId

integer · int32 · required

runId

integer · int32 · required

Get Insight Data › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Insight Data › Responses

Success

facilityId

integer · int32 · required

runId

integer · int32 · required

benchmarkFacilityId

integer · int32

object[]

object

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs/:runId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runId": 0,
  "benchmarkFacilityId": 0,
  "wealth": [
    {
      "type": 0,
      "selection": [
        {
          "label": "label",
          "dataPoints": [
            {
              "label": "label",
              "value": 0,
              "benchmark": 0,
              "bottom": 0
            }
          ]
        }
      ]
    }
  ],
  "stats": {
    "totalRecords": 0,
    "matchedRecords": 0,
    "matchRate": 0
  }
}

json

application/json

Get Insight Data With Benchmark

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmark/{benchmarkFacilityId}

Get Insight Data With Benchmark › path Parameters

facilityId

integer · int32 · required

runId

integer · int32 · required

benchmarkFacilityId

integer · int32 · required

Get Insight Data With Benchmark › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Insight Data With Benchmark › Responses

Success

facilityId

integer · int32 · required

runId

integer · int32 · required

benchmarkFacilityId

integer · int32

object[]

object

GET/api/v1/ClientResidentInsight/facilities/{facilityId}/runs/{runId}/benchmark/{benchmarkFacilityId}

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/facilities/:facilityId/runs/:runId/benchmark/:benchmarkFacilityId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "facilityId": 0,
  "runId": 0,
  "benchmarkFacilityId": 0,
  "wealth": [
    {
      "type": 0,
      "selection": [
        {
          "label": "label",
          "dataPoints": [
            {
              "label": "label",
              "value": 0,
              "benchmark": 0,
              "bottom": 0
            }
          ]
        }
      ]
    }
  ],
  "stats": {
    "totalRecords": 0,
    "matchedRecords": 0,
    "matchRate": 0
  }
}

json

application/json

Get Mosaic Definitions

GET

https://api.nicmap.com

/api/v1/ClientResidentInsight/mosaic-definitions

Get Mosaic Definitions › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Mosaic Definitions › Responses

Success

object[]

GET/api/v1/ClientResidentInsight/mosaic-definitions

curl --request GET \
  --url https://api.nicmap.com/api/v1/ClientResidentInsight/mosaic-definitions \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "definitions": [
    {
      "label": "label",
      "title": "title",
      "description": "description"
    }
  ]
}

json

application/json