Funnel

🚧

Experimental Feature

The References API is currently an experimental feature. Therefore, the API and this documentation is subject to change. If you have any questions, please email Engrain Support.

Introduction

References for Funnel are indicated by the key property being set to funnel.

📘

Something Missing?

You may notice a reference does not exist for an asset or unit even though your customer is using Funnel as a data provider. This is likely because we have yet to create these references for Funnel. Engrain must first gather and match the values for each asset and unit. If this is the case and you are interested in references being provided, please email Engrain Support.

Asset Reference

Asset references for Funnel are matched to a Community_ID value, which is provided to Engrain by the customer or gathered from the Funnel API.

📌

Funnel does not have an endpoint to gather the necessary Community ID values. Currently, these IDs will need to be obtained directly from your Funnel representative.

The following cURL request will only list Funnel asset references for which the API Key has access to.

curl 'https://api.unitmap.com/v1/assets/references?key=funnel' \
  -H 'API-key: API_KEY_GOES_HERE' \
  -H 'Experimental-Flags: references'

{
  "id": "10507",
  "asset_id": "16677",
  "key": "funnel",// Indicates the asset reference is for Funnel
  "value": "4587",// The matched Funnel `Community_ID` value
  "created_at": "2021-12-14T20:09:59+00:00",
  "updated_at": "2021-12-14T20:09:59+00:00"
 },

📘

For more detail on this API request, see https://api.unitmap.com/v1/openapi#tag/assetsreferences

Unit Reference

Unit references for Funnel are matched to the Unit_ID attribute.

📌

Funnel does not have an endpoint to gather the necessary Unit ID values. Currently, these IDs will need to be obtained directly from your Funnel representative.

The following cURL request will only list Funnel unit references for which the API Key has access to.

curl 'https://api.unitmap.com/v1/units/references?key=funnel' \
  -H 'API-key: API_KEY_GOES_HERE' \
  -H 'Experimental-Flags: references'

{
  "group_id": "9481",
  "asset_id": "16677",
  "unit_id": "5647788",
  "key": "funnel", // Indicates the unit reference is for Funnel
  "value": "4587_4258824", // The matched Funnel `Unit_ID` attribute value
  "created_at": "2021-06-17T22:31:59+00:00",
  "updated_at": "2021-06-17T22:31:59+00:00"
},

📘

For more detail on this API request, see https://api.unitmap.com/v1/openapi#tag/unitsreferences