Connectors

The Mapped API allows you to make calls to retrieve information about the installed Connectors in your org. In this guide, we'll walk through how to retrieve basic info like name and ID, as well as how to filter down to see all the things and points associated with a specific Connector.

If you're looking to add, update or remove a connector, that can be found here. For specific Connector Guides, showing how to setup a Connector or code samples relevant to specific Connectors, please go here.

Viewing Connectors

There's a lot of core information available about your Connectors - name, id, when it was created, the current state of the Connector (like ACTIVE or STOPPED) and so on. In the following example, we'll include all that data, along with information about the type:

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  connectors {
    id
    name
    created
    connectorType {
      name
      description
      direction
      version
    }
    state
  }
}

The name field listed in the beginning is the name you provides to the Connector when it was originally setup - this is often left as the default, but can be customized in scenarios where a more descriptive name is needed (like "Weather Development" and "Weather Production"). Under connectorType, the name value is what we assigned to the Connector and is not modifiable.

Additional fields under connectorType include description, direction and version. The direction value indicates whether this Connector is SOURCE or DESTINATION focused. SOURCE means data is flowing from the connector to your org - data from sensors, like the humidity level in a room. DESTINATION means the Connector is sending data from your org to somewhere else, like an external data lake. The version will let you know which release of the Connector is installed, as over time we may have multiple releases.

Viewing Things & Points by Connector

When you initially add a Connector, it might not be obvious what types of things and points will be added to your data. You can filter by the Connector id and then include both the things and points fields to retrieve that information, including the latest time series data and even unit information (like Degree Celsius):

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  connectors(filter: {id: {eq: "CONXG1u32osqN7eyzntnrABCD"}}) {
    name
    things {
      id
      name
      exactType
      points {
        id
        name
        exactType
        unit {
          name
          description
        }
        series(latest: true) {
          value {
            float64Value
          }
        }
      }
    }
  }
}