GraphQL API Reference

Welcome to ECOROUTE API documentation

This is your gateway to unlocking the full potential of our services.

Whether you're crafting innovative applications, automating processes, or integrating with existing systems, our API provides the tools you need to succeed. Dive into our comprehensive documentation, discover endpoints, and unleash the power of seamless integration.

We wish you good luck and have fun building amazing creations!

Contact

Need help?

[email protected]

Terms of Service

https://ecoroute.io/tos

API Endpoints
# Production:
https://api.ecoroute.io/graphql
Headers
# Your API token from "/token". Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>
Version

0.6.2

Quickstart

Create Account

  1. Open Ecoroute Registration and follow the instructions.

Receive API Token

Execute the following command

$ curl --location 'https://api.ecoroute.io/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "<YOUR_USERNAME>", 
    "password": "<YOUR_PASSWORD>",
    "audience": "https://api.ecoroute",
    "grant_type": "password"
}'

Get your user

Execute the following command

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data-raw '{
    "query":"query(first: Int!, offset: Int!) {\n    queryUser(first: $first, offset: $offset) {\n        id\n        email\n        tags {\n            id\n            name\n        }\n    }\n}",
    "variables": {"operationName": "queryUser", "first": 100, "offset": 0}
}'

Add your first Tag

Execute the following command

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data '{
    "query":"mutation($input: [AddTagInput!]!){\n  addTag(input: $input){\n    tag {\n      id\n      name\n      users {\n        id\n      }\n    }\n    numUids\n  }\n}",
    "variables":{
        "input":{
            "name":"<YOUR_TAG_NAME>",
            "users":[
                {
                    "id":"<YOUR_USER_ID>",
                    "email":"<YOUR_EMAIL>"
                }
            ],
            "createdAt":"2023-05-07T21:23:34.409Z"
        },
        "operationName": "addTag"
    }
}'

Execute the following command

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data '{
    "query":"mutation($input: [AddSearchSetInput!]!){\n  addSearchSet(input: $input){\n    searchSet {\n     \tid\n      start\n      destination\n      tags {\n        id\n        name\n        users {\n          id\n        }\n      }\n      createdAt\n      state\n    }\n  }\n}",
    "variables":{
        "input": [
            {
                "start":"<YOUR_START>",
                "destination":"<YOUR_DESTINATION>",
                "tags":[
                    {
                        "id":"<YOUR_TAG_ID>"
                    }
                ],
                "active":true,
                "createdAt":"2023-05-07T20:31:02Z",
                "state":"NEW"
            }
        ],
        "operationName": "addSearchSet"
    }
}'

Usage information

To guarantee the same quality of service for all our users, each request that uses our "/graphql"-endpoint and uses a "query*"-function (for example querySeaches, queryMatches, querySearchSet) has to contain 3 variables in it's payload.

The mentioned variables are marked as mandatory in our detailed api documentation (pay attention to the "!" next to variables)

If you are not familiar with the usage of "variables" we recommend reading the following source: https://graphql.org/

JSON-Schema

"variables": {
    "type": "object",
    "properties": {
        "first": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100
        },
        "offset": {
            "type": "integer",
            "minimum": 0
        },
        "operationName": {
            "type": "string"
        }
    }
}

Example Payload

{"variables":{"first":10,"offset":0,"operationName": "queryTag"},"query":"query($filter: TagFilter!, $first: Int!, $offset: Int!) {\n    queryTag(filter: $filter, first: $first, offset: $offset) {\n        id\n        name\n        users {\n            id\n        }\n        searchSets {\n            searchesAggregate {\n                count\n            }\n            id\n            createdAt\n            state\n            start\n            destination\n            active\n            mergeSet {\n                id\n            }\n            searches {\n                id\n                distance\n                active\n                waypoints {\n                    id\n                    value\n                    sortOrder\n                }\n            }\n            owningMergeSet {\n                id\n            }\n            mergeSet {\n                id\n            }\n        }\n    }\n}"}

Collaboration

Share Tags

Receive your tags

Execute the following command for the party who owns the tag

curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data-raw '{
    "query":"query {\n    queryTag {\n        id\n        name\n        users {\n            id\n        }\n        searches {\n            id\n        }\n        searchesAggregate {\n            count\n        }\n    }\n}",
    "variables":{}
}'

Get your user

Execute the following command once for the party who wants to collaborate and once for the party who owns the tag

$ curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data-raw '{
    "query":"query {\n    queryUser {\n        id\n        email\n        tags {\n            id\n            name\n        }\n    }\n}",
    "variables": {}
}'

Add additional user to tag

Execute the following command for the party who owns the tag

curl --location 'https://api.ecoroute.io/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--data '{
    "query":"mutation($input: UpdateTagInput!){\n  updateTag(input: $input){\n    tag {\n      id\n      name\n      users {\n        id\n      }\n    }\n    numUids\n  }\n}",
    "variables":{
        "input":{
            "filter":{
                "id":["<TAG_ID>"]
            },
            "set":{
                "users":[
                    {
                        "id":"<USER_ID_OWNER>"
                    },
                    {
                        "id":"<USER_ID_COLLABORATOR>"
                    }
                ]
            }
        }
    }
}'

Queries

aggregateMergeSet

Response

Returns a MergeSetAggregateResult

Arguments
Name Description
filter - MergeSetFilter

Example

Query
query AggregateMergeSet($filter: MergeSetFilter) {
  aggregateMergeSet(filter: $filter) {
    count
    createdAtMin
    createdAtMax
    savedDistanceMin
    savedDistanceMax
    savedDistanceSum
    savedDistanceAvg
  }
}
Variables
{"filter": MergeSetFilter}
Response
{
  "data": {
    "aggregateMergeSet": {
      "count": 987,
      "createdAtMin": "2007-12-03T10:15:30Z",
      "createdAtMax": "2007-12-03T10:15:30Z",
      "savedDistanceMin": 123.45,
      "savedDistanceMax": 123.45,
      "savedDistanceSum": 987.65,
      "savedDistanceAvg": 123.45
    }
  }
}

aggregatePrediction

Response

Returns a PredictionAggregateResult

Arguments
Name Description
filter - PredictionFilter

Example

Query
query AggregatePrediction($filter: PredictionFilter) {
  aggregatePrediction(filter: $filter) {
    count
    descriptionMin
    descriptionMax
  }
}
Variables
{"filter": PredictionFilter}
Response
{
  "data": {
    "aggregatePrediction": {
      "count": 123,
      "descriptionMin": "xyz789",
      "descriptionMax": "xyz789"
    }
  }
}

aggregateSearch

Response

Returns a SearchAggregateResult

Arguments
Name Description
filter - SearchFilter

Example

Query
query AggregateSearch($filter: SearchFilter) {
  aggregateSearch(filter: $filter) {
    count
    idMin
    idMax
    distanceMin
    distanceMax
    distanceSum
    distanceAvg
    createdAtMin
    createdAtMax
  }
}
Variables
{"filter": SearchFilter}
Response
{
  "data": {
    "aggregateSearch": {
      "count": 987,
      "idMin": "xyz789",
      "idMax": "abc123",
      "distanceMin": 123.45,
      "distanceMax": 987.65,
      "distanceSum": 987.65,
      "distanceAvg": 987.65,
      "createdAtMin": "2007-12-03T10:15:30Z",
      "createdAtMax": "2007-12-03T10:15:30Z"
    }
  }
}

aggregateSearchSet

Response

Returns a SearchSetAggregateResult

Arguments
Name Description
filter - SearchSetFilter

Example

Query
query AggregateSearchSet($filter: SearchSetFilter) {
  aggregateSearchSet(filter: $filter) {
    count
    startMin
    startMax
    destinationMin
    destinationMax
    createdAtMin
    createdAtMax
  }
}
Variables
{"filter": SearchSetFilter}
Response
{
  "data": {
    "aggregateSearchSet": {
      "count": 123,
      "startMin": "xyz789",
      "startMax": "xyz789",
      "destinationMin": "abc123",
      "destinationMax": "abc123",
      "createdAtMin": "2007-12-03T10:15:30Z",
      "createdAtMax": "2007-12-03T10:15:30Z"
    }
  }
}

getMatchSet

Response

Returns a MatchSet

Arguments
Name Description
id - ID!

Example

Query
query GetMatchSet($id: ID!) {
  getMatchSet(id: $id) {
    id
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matches {
      id
      coverageSearch
      coverageMatch
      matchRatio
      matchSet {
        ...MatchSetFragment
      }
      search {
        ...SearchFragment
      }
      createdAt
      matchSetAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    minCoverageSearch
    minCoverageMatch
    matchFactor
    createdAt
    state
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchesAggregate {
      count
      coverageSearchMin
      coverageSearchMax
      coverageSearchSum
      coverageSearchAvg
      coverageMatchMin
      coverageMatchMax
      coverageMatchSum
      coverageMatchAvg
      matchRatioMin
      matchRatioMax
      matchRatioSum
      matchRatioAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getMatchSet": {
      "id": 4,
      "search": Search,
      "tags": [Tag],
      "matches": [Match],
      "minCoverageSearch": 123.45,
      "minCoverageMatch": 987.65,
      "matchFactor": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "state": "NEW",
      "tagsAggregate": TagAggregateResult,
      "matchesAggregate": MatchAggregateResult
    }
  }
}

getMergeSet

Response

Returns a MergeSet

Arguments
Name Description
id - ID!

Example

Query
query GetMergeSet($id: ID!) {
  getMergeSet(id: $id) {
    id
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    baseSearchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSearchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    createdAt
    savedDistance
    state
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getMergeSet": {
      "id": "4",
      "tags": [Tag],
      "baseSearchSet": SearchSet,
      "mergeSearchSet": SearchSet,
      "searchSet": SearchSet,
      "createdAt": "2007-12-03T10:15:30Z",
      "savedDistance": 123.45,
      "state": "NEW",
      "tagsAggregate": TagAggregateResult
    }
  }
}

getPredictions

Response

Returns a Predictions

Arguments
Name Description
input - String!

Example

Query
query GetPredictions($input: String!) {
  getPredictions(input: $input) {
    predictions {
      description
    }
  }
}
Variables
{"input": "abc123"}
Response
{
  "data": {
    "getPredictions": {"predictions": [Prediction]}
  }
}

getSearch

Response

Returns a Search

Arguments
Name Description
id - String!

Example

Query
query GetSearch($id: String!) {
  getSearch(id: $id) {
    id
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    startPoint {
      longitude
      latitude
    }
    destinationPoint {
      longitude
      latitude
    }
    waypoints {
      id
      value
      sortOrder
      marker {
        ...PointFragment
      }
      search {
        ...SearchFragment
      }
    }
    polygonLine {
      coordinates {
        ...PointListFragment
      }
    }
    active
    distance
    lineString {
      coordinates {
        ...PointListFragment
      }
    }
    createdAt
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matchSets {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    waypointsAggregate {
      count
      idMin
      idMax
      valueMin
      valueMax
      sortOrderMin
      sortOrderMax
      sortOrderSum
      sortOrderAvg
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchSetsAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "getSearch": {
      "id": "xyz789",
      "searchSet": SearchSet,
      "startPoint": Point,
      "destinationPoint": Point,
      "waypoints": [Waypoint],
      "polygonLine": Polygon,
      "active": true,
      "distance": 123.45,
      "lineString": Polygon,
      "createdAt": "2007-12-03T10:15:30Z",
      "tags": [Tag],
      "matchSets": [MatchSet],
      "waypointsAggregate": WaypointAggregateResult,
      "tagsAggregate": TagAggregateResult,
      "matchSetsAggregate": MatchSetAggregateResult
    }
  }
}

getSearchSet

Response

Returns a SearchSet

Arguments
Name Description
id - ID!

Example

Query
query GetSearchSet($id: ID!) {
  getSearchSet(id: $id) {
    id
    searches {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    start
    destination
    baseMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    active
    createdAt
    state
    searchesAggregate {
      count
      idMin
      idMax
      distanceMin
      distanceMax
      distanceSum
      distanceAvg
      createdAtMin
      createdAtMax
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getSearchSet": {
      "id": 4,
      "searches": [Search],
      "tags": [Tag],
      "start": "xyz789",
      "destination": "abc123",
      "baseMergeSet": MergeSet,
      "mergeMergeSet": MergeSet,
      "mergeSet": MergeSet,
      "active": true,
      "createdAt": "2007-12-03T10:15:30Z",
      "state": "NEW",
      "searchesAggregate": SearchAggregateResult,
      "tagsAggregate": TagAggregateResult
    }
  }
}

getTag

Response

Returns a Tag

Arguments
Name Description
id - ID!

Example

Query
query GetTag($id: ID!) {
  getTag(id: $id) {
    id
    name
    users {
      id
      email
      tags {
        ...TagFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    searchSets {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSets {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    matchSets {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    searches {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    createdAt
    usersAggregate {
      count
      idMin
      idMax
      emailMin
      emailMax
    }
    searchSetsAggregate {
      count
      startMin
      startMax
      destinationMin
      destinationMax
      createdAtMin
      createdAtMax
    }
    mergeSetsAggregate {
      count
      createdAtMin
      createdAtMax
      savedDistanceMin
      savedDistanceMax
      savedDistanceSum
      savedDistanceAvg
    }
    matchSetsAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
    searchesAggregate {
      count
      idMin
      idMax
      distanceMin
      distanceMax
      distanceSum
      distanceAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getTag": {
      "id": 4,
      "name": "xyz789",
      "users": [User],
      "searchSets": [SearchSet],
      "mergeSets": [MergeSet],
      "matchSets": [MatchSet],
      "searches": [Search],
      "createdAt": "2007-12-03T10:15:30Z",
      "usersAggregate": UserAggregateResult,
      "searchSetsAggregate": SearchSetAggregateResult,
      "mergeSetsAggregate": MergeSetAggregateResult,
      "matchSetsAggregate": MatchSetAggregateResult,
      "searchesAggregate": SearchAggregateResult
    }
  }
}

getUser

Response

Returns a User

Arguments
Name Description
id - String!

Example

Query
query GetUser($id: String!) {
  getUser(id: $id) {
    id
    email
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "getUser": {
      "id": "abc123",
      "email": "abc123",
      "tags": [Tag],
      "tagsAggregate": TagAggregateResult
    }
  }
}

queryMatch

Response

Returns [Match]

Arguments
Name Description
filter - MatchFilter
order - MatchOrder
first - Int!
offset - Int!

Example

Query
query QueryMatch(
  $filter: MatchFilter,
  $order: MatchOrder,
  $first: Int!,
  $offset: Int!
) {
  queryMatch(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    coverageSearch
    coverageMatch
    matchRatio
    matchSet {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    createdAt
    matchSetAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": MatchFilter,
  "order": MatchOrder,
  "first": 123,
  "offset": 987
}
Response
{
  "data": {
    "queryMatch": [
      {
        "id": 4,
        "coverageSearch": 123.45,
        "coverageMatch": 123.45,
        "matchRatio": 987.65,
        "matchSet": [MatchSet],
        "search": Search,
        "createdAt": "2007-12-03T10:15:30Z",
        "matchSetAggregate": MatchSetAggregateResult
      }
    ]
  }
}

queryMatchSet

Response

Returns [MatchSet]

Arguments
Name Description
filter - MatchSetFilter
order - MatchSetOrder
first - Int!
offset - Int!

Example

Query
query QueryMatchSet(
  $filter: MatchSetFilter,
  $order: MatchSetOrder,
  $first: Int!,
  $offset: Int!
) {
  queryMatchSet(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matches {
      id
      coverageSearch
      coverageMatch
      matchRatio
      matchSet {
        ...MatchSetFragment
      }
      search {
        ...SearchFragment
      }
      createdAt
      matchSetAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    minCoverageSearch
    minCoverageMatch
    matchFactor
    createdAt
    state
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchesAggregate {
      count
      coverageSearchMin
      coverageSearchMax
      coverageSearchSum
      coverageSearchAvg
      coverageMatchMin
      coverageMatchMax
      coverageMatchSum
      coverageMatchAvg
      matchRatioMin
      matchRatioMax
      matchRatioSum
      matchRatioAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": MatchSetFilter,
  "order": MatchSetOrder,
  "first": 987,
  "offset": 987
}
Response
{
  "data": {
    "queryMatchSet": [
      {
        "id": "4",
        "search": Search,
        "tags": [Tag],
        "matches": [Match],
        "minCoverageSearch": 123.45,
        "minCoverageMatch": 123.45,
        "matchFactor": 123.45,
        "createdAt": "2007-12-03T10:15:30Z",
        "state": "NEW",
        "tagsAggregate": TagAggregateResult,
        "matchesAggregate": MatchAggregateResult
      }
    ]
  }
}

queryMergeSet

Response

Returns [MergeSet]

Arguments
Name Description
filter - MergeSetFilter
order - MergeSetOrder
first - Int!
offset - Int!

Example

Query
query QueryMergeSet(
  $filter: MergeSetFilter,
  $order: MergeSetOrder,
  $first: Int!,
  $offset: Int!
) {
  queryMergeSet(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    baseSearchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSearchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    createdAt
    savedDistance
    state
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": MergeSetFilter,
  "order": MergeSetOrder,
  "first": 123,
  "offset": 987
}
Response
{
  "data": {
    "queryMergeSet": [
      {
        "id": "4",
        "tags": [Tag],
        "baseSearchSet": SearchSet,
        "mergeSearchSet": SearchSet,
        "searchSet": SearchSet,
        "createdAt": "2007-12-03T10:15:30Z",
        "savedDistance": 123.45,
        "state": "NEW",
        "tagsAggregate": TagAggregateResult
      }
    ]
  }
}

queryPrediction

Response

Returns [Prediction]

Arguments
Name Description
filter - PredictionFilter
order - PredictionOrder
first - Int!
offset - Int!

Example

Query
query QueryPrediction(
  $filter: PredictionFilter,
  $order: PredictionOrder,
  $first: Int!,
  $offset: Int!
) {
  queryPrediction(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    description
  }
}
Variables
{
  "filter": PredictionFilter,
  "order": PredictionOrder,
  "first": 123,
  "offset": 987
}
Response
{
  "data": {
    "queryPrediction": [
      {"description": "abc123"}
    ]
  }
}

querySearch

Response

Returns [Search]

Arguments
Name Description
filter - SearchFilter
order - SearchOrder
first - Int!
offset - Int!

Example

Query
query QuerySearch(
  $filter: SearchFilter,
  $order: SearchOrder,
  $first: Int!,
  $offset: Int!
) {
  querySearch(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    startPoint {
      longitude
      latitude
    }
    destinationPoint {
      longitude
      latitude
    }
    waypoints {
      id
      value
      sortOrder
      marker {
        ...PointFragment
      }
      search {
        ...SearchFragment
      }
    }
    polygonLine {
      coordinates {
        ...PointListFragment
      }
    }
    active
    distance
    lineString {
      coordinates {
        ...PointListFragment
      }
    }
    createdAt
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matchSets {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    waypointsAggregate {
      count
      idMin
      idMax
      valueMin
      valueMax
      sortOrderMin
      sortOrderMax
      sortOrderSum
      sortOrderAvg
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchSetsAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": SearchFilter,
  "order": SearchOrder,
  "first": 987,
  "offset": 123
}
Response
{
  "data": {
    "querySearch": [
      {
        "id": "xyz789",
        "searchSet": SearchSet,
        "startPoint": Point,
        "destinationPoint": Point,
        "waypoints": [Waypoint],
        "polygonLine": Polygon,
        "active": false,
        "distance": 987.65,
        "lineString": Polygon,
        "createdAt": "2007-12-03T10:15:30Z",
        "tags": [Tag],
        "matchSets": [MatchSet],
        "waypointsAggregate": WaypointAggregateResult,
        "tagsAggregate": TagAggregateResult,
        "matchSetsAggregate": MatchSetAggregateResult
      }
    ]
  }
}

querySearchSet

Response

Returns [SearchSet]

Arguments
Name Description
filter - SearchSetFilter
order - SearchSetOrder
first - Int!
offset - Int!

Example

Query
query QuerySearchSet(
  $filter: SearchSetFilter,
  $order: SearchSetOrder,
  $first: Int!,
  $offset: Int!
) {
  querySearchSet(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    searches {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    start
    destination
    baseMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    active
    createdAt
    state
    searchesAggregate {
      count
      idMin
      idMax
      distanceMin
      distanceMax
      distanceSum
      distanceAvg
      createdAtMin
      createdAtMax
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": SearchSetFilter,
  "order": SearchSetOrder,
  "first": 987,
  "offset": 987
}
Response
{
  "data": {
    "querySearchSet": [
      {
        "id": "4",
        "searches": [Search],
        "tags": [Tag],
        "start": "abc123",
        "destination": "abc123",
        "baseMergeSet": MergeSet,
        "mergeMergeSet": MergeSet,
        "mergeSet": MergeSet,
        "active": true,
        "createdAt": "2007-12-03T10:15:30Z",
        "state": "NEW",
        "searchesAggregate": SearchAggregateResult,
        "tagsAggregate": TagAggregateResult
      }
    ]
  }
}

queryTag

Response

Returns [Tag]

Arguments
Name Description
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!

Example

Query
query QueryTag(
  $filter: TagFilter,
  $order: TagOrder,
  $first: Int!,
  $offset: Int!
) {
  queryTag(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    name
    users {
      id
      email
      tags {
        ...TagFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    searchSets {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSets {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    matchSets {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    searches {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    createdAt
    usersAggregate {
      count
      idMin
      idMax
      emailMin
      emailMax
    }
    searchSetsAggregate {
      count
      startMin
      startMax
      destinationMin
      destinationMax
      createdAtMin
      createdAtMax
    }
    mergeSetsAggregate {
      count
      createdAtMin
      createdAtMax
      savedDistanceMin
      savedDistanceMax
      savedDistanceSum
      savedDistanceAvg
    }
    matchSetsAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
    searchesAggregate {
      count
      idMin
      idMax
      distanceMin
      distanceMax
      distanceSum
      distanceAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": TagFilter,
  "order": TagOrder,
  "first": 123,
  "offset": 987
}
Response
{
  "data": {
    "queryTag": [
      {
        "id": "4",
        "name": "xyz789",
        "users": [User],
        "searchSets": [SearchSet],
        "mergeSets": [MergeSet],
        "matchSets": [MatchSet],
        "searches": [Search],
        "createdAt": "2007-12-03T10:15:30Z",
        "usersAggregate": UserAggregateResult,
        "searchSetsAggregate": SearchSetAggregateResult,
        "mergeSetsAggregate": MergeSetAggregateResult,
        "matchSetsAggregate": MatchSetAggregateResult,
        "searchesAggregate": SearchAggregateResult
      }
    ]
  }
}

queryUser

Response

Returns [User]

Arguments
Name Description
filter - UserFilter
order - UserOrder
first - Int!
offset - Int!

Example

Query
query QueryUser(
  $filter: UserFilter,
  $order: UserOrder,
  $first: Int!,
  $offset: Int!
) {
  queryUser(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    email
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": UserFilter,
  "order": UserOrder,
  "first": 987,
  "offset": 987
}
Response
{
  "data": {
    "queryUser": [
      {
        "id": "abc123",
        "email": "abc123",
        "tags": [Tag],
        "tagsAggregate": TagAggregateResult
      }
    ]
  }
}

Mutations

addMatch

Response

Returns an AddMatchPayload

Arguments
Name Description
input - [AddMatchInput!]!

Example

Query
mutation AddMatch($input: [AddMatchInput!]!) {
  addMatch(input: $input) {
    match {
      id
      coverageSearch
      coverageMatch
      matchRatio
      matchSet {
        ...MatchSetFragment
      }
      search {
        ...SearchFragment
      }
      createdAt
      matchSetAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": [AddMatchInput]}
Response
{"data": {"addMatch": {"match": [Match], "numUids": 987}}}

addMatchSet

Response

Returns an AddMatchSetPayload

Arguments
Name Description
input - [AddMatchSetInput!]!

Example

Query
mutation AddMatchSet($input: [AddMatchSetInput!]!) {
  addMatchSet(input: $input) {
    matchSet {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": [AddMatchSetInput]}
Response
{
  "data": {
    "addMatchSet": {
      "matchSet": [MatchSet],
      "numUids": 987
    }
  }
}

addMergeSet

Response

Returns an AddMergeSetPayload

Arguments
Name Description
input - [AddMergeSetInput!]!

Example

Query
mutation AddMergeSet($input: [AddMergeSetInput!]!) {
  addMergeSet(input: $input) {
    mergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": [AddMergeSetInput]}
Response
{
  "data": {
    "addMergeSet": {
      "mergeSet": [MergeSet],
      "numUids": 123
    }
  }
}

addPrediction

Response

Returns an AddPredictionPayload

Arguments
Name Description
input - [AddPredictionInput!]!

Example

Query
mutation AddPrediction($input: [AddPredictionInput!]!) {
  addPrediction(input: $input) {
    prediction {
      description
    }
    numUids
  }
}
Variables
{"input": [AddPredictionInput]}
Response
{
  "data": {
    "addPrediction": {
      "prediction": [Prediction],
      "numUids": 123
    }
  }
}

addSearch

Response

Returns an AddSearchPayload

Arguments
Name Description
input - [AddSearchInput!]!
upsert - Boolean

Example

Query
mutation AddSearch(
  $input: [AddSearchInput!]!,
  $upsert: Boolean
) {
  addSearch(
    input: $input,
    upsert: $upsert
  ) {
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": [AddSearchInput], "upsert": false}
Response
{
  "data": {
    "addSearch": {"search": [Search], "numUids": 987}
  }
}

addSearchSet

Response

Returns an AddSearchSetPayload

Arguments
Name Description
input - [AddSearchSetInput!]!

Example

Query
mutation AddSearchSet($input: [AddSearchSetInput!]!) {
  addSearchSet(input: $input) {
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": [AddSearchSetInput]}
Response
{
  "data": {
    "addSearchSet": {
      "searchSet": [SearchSet],
      "numUids": 987
    }
  }
}

addTag

Response

Returns an AddTagPayload

Arguments
Name Description
input - [AddTagInput!]!

Example

Query
mutation AddTag($input: [AddTagInput!]!) {
  addTag(input: $input) {
    tag {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": [AddTagInput]}
Response
{"data": {"addTag": {"tag": [Tag], "numUids": 123}}}

addUser

Response

Returns an AddUserPayload

Arguments
Name Description
input - [AddUserInput!]!
upsert - Boolean

Example

Query
mutation AddUser(
  $input: [AddUserInput!]!,
  $upsert: Boolean
) {
  addUser(
    input: $input,
    upsert: $upsert
  ) {
    user {
      id
      email
      tags {
        ...TagFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": [AddUserInput], "upsert": true}
Response
{"data": {"addUser": {"user": [User], "numUids": 123}}}

deleteMatch

Response

Returns a DeleteMatchPayload

Arguments
Name Description
filter - MatchFilter!

Example

Query
mutation DeleteMatch($filter: MatchFilter!) {
  deleteMatch(filter: $filter) {
    match {
      id
      coverageSearch
      coverageMatch
      matchRatio
      matchSet {
        ...MatchSetFragment
      }
      search {
        ...SearchFragment
      }
      createdAt
      matchSetAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    msg
    numUids
  }
}
Variables
{"filter": MatchFilter}
Response
{
  "data": {
    "deleteMatch": {
      "match": [Match],
      "msg": "xyz789",
      "numUids": 987
    }
  }
}

deleteMatchSet

Response

Returns a DeleteMatchSetPayload

Arguments
Name Description
filter - MatchSetFilter!

Example

Query
mutation DeleteMatchSet($filter: MatchSetFilter!) {
  deleteMatchSet(filter: $filter) {
    matchSet {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    msg
    numUids
  }
}
Variables
{"filter": MatchSetFilter}
Response
{
  "data": {
    "deleteMatchSet": {
      "matchSet": [MatchSet],
      "msg": "abc123",
      "numUids": 123
    }
  }
}

deleteMergeSet

Response

Returns a DeleteMergeSetPayload

Arguments
Name Description
filter - MergeSetFilter!

Example

Query
mutation DeleteMergeSet($filter: MergeSetFilter!) {
  deleteMergeSet(filter: $filter) {
    mergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    msg
    numUids
  }
}
Variables
{"filter": MergeSetFilter}
Response
{
  "data": {
    "deleteMergeSet": {
      "mergeSet": [MergeSet],
      "msg": "abc123",
      "numUids": 987
    }
  }
}

deletePrediction

Response

Returns a DeletePredictionPayload

Arguments
Name Description
filter - PredictionFilter!

Example

Query
mutation DeletePrediction($filter: PredictionFilter!) {
  deletePrediction(filter: $filter) {
    prediction {
      description
    }
    msg
    numUids
  }
}
Variables
{"filter": PredictionFilter}
Response
{
  "data": {
    "deletePrediction": {
      "prediction": [Prediction],
      "msg": "xyz789",
      "numUids": 123
    }
  }
}

deleteSearch

Response

Returns a DeleteSearchPayload

Arguments
Name Description
filter - SearchFilter!

Example

Query
mutation DeleteSearch($filter: SearchFilter!) {
  deleteSearch(filter: $filter) {
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    msg
    numUids
  }
}
Variables
{"filter": SearchFilter}
Response
{
  "data": {
    "deleteSearch": {
      "search": [Search],
      "msg": "abc123",
      "numUids": 123
    }
  }
}

deleteSearchSet

Response

Returns a DeleteSearchSetPayload

Arguments
Name Description
filter - SearchSetFilter!

Example

Query
mutation DeleteSearchSet($filter: SearchSetFilter!) {
  deleteSearchSet(filter: $filter) {
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    msg
    numUids
  }
}
Variables
{"filter": SearchSetFilter}
Response
{
  "data": {
    "deleteSearchSet": {
      "searchSet": [SearchSet],
      "msg": "xyz789",
      "numUids": 123
    }
  }
}

deleteTag

Response

Returns a DeleteTagPayload

Arguments
Name Description
filter - TagFilter!

Example

Query
mutation DeleteTag($filter: TagFilter!) {
  deleteTag(filter: $filter) {
    tag {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    msg
    numUids
  }
}
Variables
{"filter": TagFilter}
Response
{
  "data": {
    "deleteTag": {
      "tag": [Tag],
      "msg": "xyz789",
      "numUids": 987
    }
  }
}

deleteUser

Response

Returns a DeleteUserPayload

Arguments
Name Description
filter - UserFilter!

Example

Query
mutation DeleteUser($filter: UserFilter!) {
  deleteUser(filter: $filter) {
    user {
      id
      email
      tags {
        ...TagFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    msg
    numUids
  }
}
Variables
{"filter": UserFilter}
Response
{
  "data": {
    "deleteUser": {
      "user": [User],
      "msg": "xyz789",
      "numUids": 987
    }
  }
}

updateMatchSet

Response

Returns an UpdateMatchSetPayload

Arguments
Name Description
input - UpdateMatchSetInput!

Example

Query
mutation UpdateMatchSet($input: UpdateMatchSetInput!) {
  updateMatchSet(input: $input) {
    matchSet {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": UpdateMatchSetInput}
Response
{
  "data": {
    "updateMatchSet": {
      "matchSet": [MatchSet],
      "numUids": 123
    }
  }
}

updateMergeSet

Response

Returns an UpdateMergeSetPayload

Arguments
Name Description
input - UpdateMergeSetInput!

Example

Query
mutation UpdateMergeSet($input: UpdateMergeSetInput!) {
  updateMergeSet(input: $input) {
    mergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": UpdateMergeSetInput}
Response
{
  "data": {
    "updateMergeSet": {
      "mergeSet": [MergeSet],
      "numUids": 123
    }
  }
}

updatePrediction

Response

Returns an UpdatePredictionPayload

Arguments
Name Description
input - UpdatePredictionInput!

Example

Query
mutation UpdatePrediction($input: UpdatePredictionInput!) {
  updatePrediction(input: $input) {
    prediction {
      description
    }
    numUids
  }
}
Variables
{"input": UpdatePredictionInput}
Response
{
  "data": {
    "updatePrediction": {
      "prediction": [Prediction],
      "numUids": 987
    }
  }
}

updateSearch

Response

Returns an UpdateSearchPayload

Arguments
Name Description
input - UpdateSearchInput!

Example

Query
mutation UpdateSearch($input: UpdateSearchInput!) {
  updateSearch(input: $input) {
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": UpdateSearchInput}
Response
{
  "data": {
    "updateSearch": {"search": [Search], "numUids": 123}
  }
}

updateSearchSet

Response

Returns an UpdateSearchSetPayload

Arguments
Name Description
input - UpdateSearchSetInput!

Example

Query
mutation UpdateSearchSet($input: UpdateSearchSetInput!) {
  updateSearchSet(input: $input) {
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": UpdateSearchSetInput}
Response
{
  "data": {
    "updateSearchSet": {
      "searchSet": [SearchSet],
      "numUids": 123
    }
  }
}

updateTag

Response

Returns an UpdateTagPayload

Arguments
Name Description
input - UpdateTagInput!

Example

Query
mutation UpdateTag($input: UpdateTagInput!) {
  updateTag(input: $input) {
    tag {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": UpdateTagInput}
Response
{"data": {"updateTag": {"tag": [Tag], "numUids": 987}}}

updateUser

Response

Returns an UpdateUserPayload

Arguments
Name Description
input - UpdateUserInput!

Example

Query
mutation UpdateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    user {
      id
      email
      tags {
        ...TagFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    numUids
  }
}
Variables
{"input": UpdateUserInput}
Response
{"data": {"updateUser": {"user": [User], "numUids": 123}}}

Subscriptions

aggregateSearch

Response

Returns a SearchAggregateResult

Arguments
Name Description
filter - SearchFilter

Example

Query
subscription AggregateSearch($filter: SearchFilter) {
  aggregateSearch(filter: $filter) {
    count
    idMin
    idMax
    distanceMin
    distanceMax
    distanceSum
    distanceAvg
    createdAtMin
    createdAtMax
  }
}
Variables
{"filter": SearchFilter}
Response
{
  "data": {
    "aggregateSearch": {
      "count": 987,
      "idMin": "abc123",
      "idMax": "abc123",
      "distanceMin": 123.45,
      "distanceMax": 987.65,
      "distanceSum": 123.45,
      "distanceAvg": 123.45,
      "createdAtMin": "2007-12-03T10:15:30Z",
      "createdAtMax": "2007-12-03T10:15:30Z"
    }
  }
}

aggregateSearchSet

Response

Returns a SearchSetAggregateResult

Arguments
Name Description
filter - SearchSetFilter

Example

Query
subscription AggregateSearchSet($filter: SearchSetFilter) {
  aggregateSearchSet(filter: $filter) {
    count
    startMin
    startMax
    destinationMin
    destinationMax
    createdAtMin
    createdAtMax
  }
}
Variables
{"filter": SearchSetFilter}
Response
{
  "data": {
    "aggregateSearchSet": {
      "count": 123,
      "startMin": "xyz789",
      "startMax": "xyz789",
      "destinationMin": "abc123",
      "destinationMax": "xyz789",
      "createdAtMin": "2007-12-03T10:15:30Z",
      "createdAtMax": "2007-12-03T10:15:30Z"
    }
  }
}

getMatchSet

Response

Returns a MatchSet

Arguments
Name Description
id - ID!

Example

Query
subscription GetMatchSet($id: ID!) {
  getMatchSet(id: $id) {
    id
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matches {
      id
      coverageSearch
      coverageMatch
      matchRatio
      matchSet {
        ...MatchSetFragment
      }
      search {
        ...SearchFragment
      }
      createdAt
      matchSetAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    minCoverageSearch
    minCoverageMatch
    matchFactor
    createdAt
    state
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchesAggregate {
      count
      coverageSearchMin
      coverageSearchMax
      coverageSearchSum
      coverageSearchAvg
      coverageMatchMin
      coverageMatchMax
      coverageMatchSum
      coverageMatchAvg
      matchRatioMin
      matchRatioMax
      matchRatioSum
      matchRatioAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getMatchSet": {
      "id": "4",
      "search": Search,
      "tags": [Tag],
      "matches": [Match],
      "minCoverageSearch": 123.45,
      "minCoverageMatch": 123.45,
      "matchFactor": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "state": "NEW",
      "tagsAggregate": TagAggregateResult,
      "matchesAggregate": MatchAggregateResult
    }
  }
}

getSearch

Response

Returns a Search

Arguments
Name Description
id - String!

Example

Query
subscription GetSearch($id: String!) {
  getSearch(id: $id) {
    id
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    startPoint {
      longitude
      latitude
    }
    destinationPoint {
      longitude
      latitude
    }
    waypoints {
      id
      value
      sortOrder
      marker {
        ...PointFragment
      }
      search {
        ...SearchFragment
      }
    }
    polygonLine {
      coordinates {
        ...PointListFragment
      }
    }
    active
    distance
    lineString {
      coordinates {
        ...PointListFragment
      }
    }
    createdAt
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matchSets {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    waypointsAggregate {
      count
      idMin
      idMax
      valueMin
      valueMax
      sortOrderMin
      sortOrderMax
      sortOrderSum
      sortOrderAvg
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchSetsAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "getSearch": {
      "id": "abc123",
      "searchSet": SearchSet,
      "startPoint": Point,
      "destinationPoint": Point,
      "waypoints": [Waypoint],
      "polygonLine": Polygon,
      "active": false,
      "distance": 987.65,
      "lineString": Polygon,
      "createdAt": "2007-12-03T10:15:30Z",
      "tags": [Tag],
      "matchSets": [MatchSet],
      "waypointsAggregate": WaypointAggregateResult,
      "tagsAggregate": TagAggregateResult,
      "matchSetsAggregate": MatchSetAggregateResult
    }
  }
}

getSearchSet

Response

Returns a SearchSet

Arguments
Name Description
id - ID!

Example

Query
subscription GetSearchSet($id: ID!) {
  getSearchSet(id: $id) {
    id
    searches {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    start
    destination
    baseMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    active
    createdAt
    state
    searchesAggregate {
      count
      idMin
      idMax
      distanceMin
      distanceMax
      distanceSum
      distanceAvg
      createdAtMin
      createdAtMax
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getSearchSet": {
      "id": 4,
      "searches": [Search],
      "tags": [Tag],
      "start": "abc123",
      "destination": "xyz789",
      "baseMergeSet": MergeSet,
      "mergeMergeSet": MergeSet,
      "mergeSet": MergeSet,
      "active": false,
      "createdAt": "2007-12-03T10:15:30Z",
      "state": "NEW",
      "searchesAggregate": SearchAggregateResult,
      "tagsAggregate": TagAggregateResult
    }
  }
}

queryMatch

Response

Returns [Match]

Arguments
Name Description
filter - MatchFilter
order - MatchOrder
first - Int!
offset - Int!

Example

Query
subscription QueryMatch(
  $filter: MatchFilter,
  $order: MatchOrder,
  $first: Int!,
  $offset: Int!
) {
  queryMatch(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    coverageSearch
    coverageMatch
    matchRatio
    matchSet {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    createdAt
    matchSetAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": MatchFilter,
  "order": MatchOrder,
  "first": 123,
  "offset": 987
}
Response
{
  "data": {
    "queryMatch": [
      {
        "id": 4,
        "coverageSearch": 987.65,
        "coverageMatch": 987.65,
        "matchRatio": 123.45,
        "matchSet": [MatchSet],
        "search": Search,
        "createdAt": "2007-12-03T10:15:30Z",
        "matchSetAggregate": MatchSetAggregateResult
      }
    ]
  }
}

queryMatchSet

Response

Returns [MatchSet]

Arguments
Name Description
filter - MatchSetFilter
order - MatchSetOrder
first - Int!
offset - Int!

Example

Query
subscription QueryMatchSet(
  $filter: MatchSetFilter,
  $order: MatchSetOrder,
  $first: Int!,
  $offset: Int!
) {
  queryMatchSet(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    search {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matches {
      id
      coverageSearch
      coverageMatch
      matchRatio
      matchSet {
        ...MatchSetFragment
      }
      search {
        ...SearchFragment
      }
      createdAt
      matchSetAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    minCoverageSearch
    minCoverageMatch
    matchFactor
    createdAt
    state
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchesAggregate {
      count
      coverageSearchMin
      coverageSearchMax
      coverageSearchSum
      coverageSearchAvg
      coverageMatchMin
      coverageMatchMax
      coverageMatchSum
      coverageMatchAvg
      matchRatioMin
      matchRatioMax
      matchRatioSum
      matchRatioAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": MatchSetFilter,
  "order": MatchSetOrder,
  "first": 987,
  "offset": 123
}
Response
{
  "data": {
    "queryMatchSet": [
      {
        "id": "4",
        "search": Search,
        "tags": [Tag],
        "matches": [Match],
        "minCoverageSearch": 987.65,
        "minCoverageMatch": 123.45,
        "matchFactor": 123.45,
        "createdAt": "2007-12-03T10:15:30Z",
        "state": "NEW",
        "tagsAggregate": TagAggregateResult,
        "matchesAggregate": MatchAggregateResult
      }
    ]
  }
}

querySearch

Response

Returns [Search]

Arguments
Name Description
filter - SearchFilter
order - SearchOrder
first - Int!
offset - Int!

Example

Query
subscription QuerySearch(
  $filter: SearchFilter,
  $order: SearchOrder,
  $first: Int!,
  $offset: Int!
) {
  querySearch(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    searchSet {
      id
      searches {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      start
      destination
      baseMergeSet {
        ...MergeSetFragment
      }
      mergeMergeSet {
        ...MergeSetFragment
      }
      mergeSet {
        ...MergeSetFragment
      }
      active
      createdAt
      state
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    startPoint {
      longitude
      latitude
    }
    destinationPoint {
      longitude
      latitude
    }
    waypoints {
      id
      value
      sortOrder
      marker {
        ...PointFragment
      }
      search {
        ...SearchFragment
      }
    }
    polygonLine {
      coordinates {
        ...PointListFragment
      }
    }
    active
    distance
    lineString {
      coordinates {
        ...PointListFragment
      }
    }
    createdAt
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    matchSets {
      id
      search {
        ...SearchFragment
      }
      tags {
        ...TagFragment
      }
      matches {
        ...MatchFragment
      }
      minCoverageSearch
      minCoverageMatch
      matchFactor
      createdAt
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchesAggregate {
        ...MatchAggregateResultFragment
      }
    }
    waypointsAggregate {
      count
      idMin
      idMax
      valueMin
      valueMax
      sortOrderMin
      sortOrderMax
      sortOrderSum
      sortOrderAvg
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
    matchSetsAggregate {
      count
      minCoverageSearchMin
      minCoverageSearchMax
      minCoverageSearchSum
      minCoverageSearchAvg
      minCoverageMatchMin
      minCoverageMatchMax
      minCoverageMatchSum
      minCoverageMatchAvg
      matchFactorMin
      matchFactorMax
      matchFactorSum
      matchFactorAvg
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": SearchFilter,
  "order": SearchOrder,
  "first": 123,
  "offset": 987
}
Response
{
  "data": {
    "querySearch": [
      {
        "id": "abc123",
        "searchSet": SearchSet,
        "startPoint": Point,
        "destinationPoint": Point,
        "waypoints": [Waypoint],
        "polygonLine": Polygon,
        "active": false,
        "distance": 987.65,
        "lineString": Polygon,
        "createdAt": "2007-12-03T10:15:30Z",
        "tags": [Tag],
        "matchSets": [MatchSet],
        "waypointsAggregate": WaypointAggregateResult,
        "tagsAggregate": TagAggregateResult,
        "matchSetsAggregate": MatchSetAggregateResult
      }
    ]
  }
}

querySearchSet

Response

Returns [SearchSet]

Arguments
Name Description
filter - SearchSetFilter
order - SearchSetOrder
first - Int!
offset - Int!

Example

Query
subscription QuerySearchSet(
  $filter: SearchSetFilter,
  $order: SearchSetOrder,
  $first: Int!,
  $offset: Int!
) {
  querySearchSet(
    filter: $filter,
    order: $order,
    first: $first,
    offset: $offset
  ) {
    id
    searches {
      id
      searchSet {
        ...SearchSetFragment
      }
      startPoint {
        ...PointFragment
      }
      destinationPoint {
        ...PointFragment
      }
      waypoints {
        ...WaypointFragment
      }
      polygonLine {
        ...PolygonFragment
      }
      active
      distance
      lineString {
        ...PolygonFragment
      }
      createdAt
      tags {
        ...TagFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      waypointsAggregate {
        ...WaypointAggregateResultFragment
      }
      tagsAggregate {
        ...TagAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
    }
    tags {
      id
      name
      users {
        ...UserFragment
      }
      searchSets {
        ...SearchSetFragment
      }
      mergeSets {
        ...MergeSetFragment
      }
      matchSets {
        ...MatchSetFragment
      }
      searches {
        ...SearchFragment
      }
      createdAt
      usersAggregate {
        ...UserAggregateResultFragment
      }
      searchSetsAggregate {
        ...SearchSetAggregateResultFragment
      }
      mergeSetsAggregate {
        ...MergeSetAggregateResultFragment
      }
      matchSetsAggregate {
        ...MatchSetAggregateResultFragment
      }
      searchesAggregate {
        ...SearchAggregateResultFragment
      }
    }
    start
    destination
    baseMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeMergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    mergeSet {
      id
      tags {
        ...TagFragment
      }
      baseSearchSet {
        ...SearchSetFragment
      }
      mergeSearchSet {
        ...SearchSetFragment
      }
      searchSet {
        ...SearchSetFragment
      }
      createdAt
      savedDistance
      state
      tagsAggregate {
        ...TagAggregateResultFragment
      }
    }
    active
    createdAt
    state
    searchesAggregate {
      count
      idMin
      idMax
      distanceMin
      distanceMax
      distanceSum
      distanceAvg
      createdAtMin
      createdAtMax
    }
    tagsAggregate {
      count
      nameMin
      nameMax
      createdAtMin
      createdAtMax
    }
  }
}
Variables
{
  "filter": SearchSetFilter,
  "order": SearchSetOrder,
  "first": 987,
  "offset": 987
}
Response
{
  "data": {
    "querySearchSet": [
      {
        "id": 4,
        "searches": [Search],
        "tags": [Tag],
        "start": "xyz789",
        "destination": "xyz789",
        "baseMergeSet": MergeSet,
        "mergeMergeSet": MergeSet,
        "mergeSet": MergeSet,
        "active": false,
        "createdAt": "2007-12-03T10:15:30Z",
        "state": "NEW",
        "searchesAggregate": SearchAggregateResult,
        "tagsAggregate": TagAggregateResult
      }
    ]
  }
}

Types

AddMatchInput

Fields
Input Field Description
coverageSearch - Float!
coverageMatch - Float!
matchRatio - Float!
matchSet - [MatchSetRef!]
search - SearchRef!
createdAt - DateTime!
Example
{
  "coverageSearch": 123.45,
  "coverageMatch": 123.45,
  "matchRatio": 987.65,
  "matchSet": [MatchSetRef],
  "search": SearchRef,
  "createdAt": "2007-12-03T10:15:30Z"
}

AddMatchPayload

Fields
Field Name Description
match - [Match]
Arguments
filter - MatchFilter
order - MatchOrder
first - Int!
offset - Int!
numUids - Int
Example
{"match": [Match], "numUids": 123}

AddMatchSetInput

Fields
Input Field Description
search - SearchRef!
tags - [TagRef!]!
matches - [MatchRef!]
minCoverageSearch - Float
minCoverageMatch - Float
matchFactor - Float!
createdAt - DateTime!
state - State!
Example
{
  "search": SearchRef,
  "tags": [TagRef],
  "matches": [MatchRef],
  "minCoverageSearch": 123.45,
  "minCoverageMatch": 123.45,
  "matchFactor": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW"
}

AddMatchSetPayload

Fields
Field Name Description
matchSet - [MatchSet]
Arguments
filter - MatchSetFilter
order - MatchSetOrder
first - Int!
offset - Int!
numUids - Int
Example
{"matchSet": [MatchSet], "numUids": 987}

AddMergeSetInput

Fields
Input Field Description
tags - [TagRef!]!
baseSearchSet - SearchSetRef!
mergeSearchSet - SearchSetRef!
searchSet - SearchSetRef
createdAt - DateTime!
savedDistance - Float!
state - State!
Example
{
  "tags": [TagRef],
  "baseSearchSet": SearchSetRef,
  "mergeSearchSet": SearchSetRef,
  "searchSet": SearchSetRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "savedDistance": 987.65,
  "state": "NEW"
}

AddMergeSetPayload

Fields
Field Name Description
mergeSet - [MergeSet]
Arguments
filter - MergeSetFilter
order - MergeSetOrder
first - Int!
offset - Int!
numUids - Int
Example
{"mergeSet": [MergeSet], "numUids": 123}

AddPredictionInput

Fields
Input Field Description
description - String!
Example
{"description": "abc123"}

AddPredictionPayload

Fields
Field Name Description
prediction - [Prediction]
Arguments
filter - PredictionFilter
order - PredictionOrder
first - Int!
offset - Int!
numUids - Int
Example
{"prediction": [Prediction], "numUids": 123}

AddSearchInput

Fields
Input Field Description
id - String!
searchSet - SearchSetRef!
startPoint - PointRef!
destinationPoint - PointRef!
waypoints - [WaypointRef]
polygonLine - PolygonRef!
active - Boolean!
distance - Float!
lineString - PolygonRef!
createdAt - DateTime!
tags - [TagRef!]!
matchSets - [MatchSetRef!]
Example
{
  "id": "abc123",
  "searchSet": SearchSetRef,
  "startPoint": PointRef,
  "destinationPoint": PointRef,
  "waypoints": [WaypointRef],
  "polygonLine": PolygonRef,
  "active": true,
  "distance": 987.65,
  "lineString": PolygonRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "tags": [TagRef],
  "matchSets": [MatchSetRef]
}

AddSearchPayload

Fields
Field Name Description
search - [Search]
Arguments
filter - SearchFilter
order - SearchOrder
first - Int!
offset - Int!
numUids - Int
Example
{"search": [Search], "numUids": 123}

AddSearchSetInput

Fields
Input Field Description
searches - [SearchRef!]
tags - [TagRef!]!
start - String!
destination - String!
baseMergeSet - MergeSetRef
mergeMergeSet - MergeSetRef
mergeSet - MergeSetRef
active - Boolean!
createdAt - DateTime!
state - State!
Example
{
  "searches": [SearchRef],
  "tags": [TagRef],
  "start": "xyz789",
  "destination": "xyz789",
  "baseMergeSet": MergeSetRef,
  "mergeMergeSet": MergeSetRef,
  "mergeSet": MergeSetRef,
  "active": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW"
}

AddSearchSetPayload

Fields
Field Name Description
searchSet - [SearchSet]
Arguments
filter - SearchSetFilter
order - SearchSetOrder
first - Int!
offset - Int!
numUids - Int
Example
{"searchSet": [SearchSet], "numUids": 987}

AddTagInput

Fields
Input Field Description
name - String!
users - [UserRef!]!
searchSets - [SearchSetRef]
mergeSets - [MergeSetRef]
matchSets - [MatchSetRef]
searches - [SearchRef!]
createdAt - DateTime!
Example
{
  "name": "xyz789",
  "users": [UserRef],
  "searchSets": [SearchSetRef],
  "mergeSets": [MergeSetRef],
  "matchSets": [MatchSetRef],
  "searches": [SearchRef],
  "createdAt": "2007-12-03T10:15:30Z"
}

AddTagPayload

Fields
Field Name Description
tag - [Tag]
Arguments
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!
numUids - Int
Example
{"tag": [Tag], "numUids": 123}

AddUserInput

Fields
Input Field Description
id - String!
email - String!
tags - [TagRef!]
Example
{
  "id": "xyz789",
  "email": "abc123",
  "tags": [TagRef]
}

AddUserPayload

Fields
Field Name Description
user - [User]
Arguments
filter - UserFilter
order - UserOrder
first - Int!
offset - Int!
numUids - Int
Example
{"user": [User], "numUids": 987}

AuthRule

Fields
Input Field Description
and - [AuthRule]
or - [AuthRule]
not - AuthRule
rule - String
Example
{
  "and": [AuthRule],
  "or": [AuthRule],
  "not": AuthRule,
  "rule": "xyz789"
}

Boolean

Description

The Boolean scalar type represents true or false.

ContainsFilter

Fields
Input Field Description
point - PointRef
polygon - PolygonRef
Example
{
  "point": PointRef,
  "polygon": PolygonRef
}

CustomHTTP

Fields
Input Field Description
url - String!
method - HTTPMethod!
body - String
graphql - String
mode - Mode
forwardHeaders - [String!]
secretHeaders - [String!]
introspectionHeaders - [String!]
skipIntrospection - Boolean
Example
{
  "url": "abc123",
  "method": "GET",
  "body": "abc123",
  "graphql": "xyz789",
  "mode": "BATCH",
  "forwardHeaders": ["xyz789"],
  "secretHeaders": ["xyz789"],
  "introspectionHeaders": ["abc123"],
  "skipIntrospection": true
}

DateTime

Description

The DateTime scalar type represents date and time as a string in RFC3339 format. For example: "1985-04-12T23:20:50.52Z" represents 20 mins 50.52 secs after the 23rd hour of Apr 12th 1985 in UTC.

Example
"2007-12-03T10:15:30Z"

DateTimeFilter

Fields
Input Field Description
eq - DateTime
in - [DateTime]
le - DateTime
lt - DateTime
ge - DateTime
gt - DateTime
between - DateTimeRange
Example
{
  "eq": "2007-12-03T10:15:30Z",
  "in": ["2007-12-03T10:15:30Z"],
  "le": "2007-12-03T10:15:30Z",
  "lt": "2007-12-03T10:15:30Z",
  "ge": "2007-12-03T10:15:30Z",
  "gt": "2007-12-03T10:15:30Z",
  "between": DateTimeRange
}

DateTimeRange

Fields
Input Field Description
min - DateTime!
max - DateTime!
Example
{
  "min": "2007-12-03T10:15:30Z",
  "max": "2007-12-03T10:15:30Z"
}

DeleteMatchPayload

Fields
Field Name Description
match - [Match]
Arguments
filter - MatchFilter
order - MatchOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "match": [Match],
  "msg": "abc123",
  "numUids": 123
}

DeleteMatchSetPayload

Fields
Field Name Description
matchSet - [MatchSet]
Arguments
filter - MatchSetFilter
order - MatchSetOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "matchSet": [MatchSet],
  "msg": "abc123",
  "numUids": 123
}

DeleteMergeSetPayload

Fields
Field Name Description
mergeSet - [MergeSet]
Arguments
filter - MergeSetFilter
order - MergeSetOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "mergeSet": [MergeSet],
  "msg": "xyz789",
  "numUids": 987
}

DeletePredictionPayload

Fields
Field Name Description
prediction - [Prediction]
Arguments
filter - PredictionFilter
order - PredictionOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "prediction": [Prediction],
  "msg": "abc123",
  "numUids": 987
}

DeleteSearchPayload

Fields
Field Name Description
search - [Search]
Arguments
filter - SearchFilter
order - SearchOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "search": [Search],
  "msg": "abc123",
  "numUids": 123
}

DeleteSearchSetPayload

Fields
Field Name Description
searchSet - [SearchSet]
Arguments
filter - SearchSetFilter
order - SearchSetOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "searchSet": [SearchSet],
  "msg": "xyz789",
  "numUids": 987
}

DeleteTagPayload

Fields
Field Name Description
tag - [Tag]
Arguments
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "tag": [Tag],
  "msg": "abc123",
  "numUids": 987
}

DeleteUserPayload

Fields
Field Name Description
user - [User]
Arguments
filter - UserFilter
order - UserOrder
first - Int!
offset - Int!
msg - String
numUids - Int
Example
{
  "user": [User],
  "msg": "abc123",
  "numUids": 123
}

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45

GenerateMutationParams

Fields
Input Field Description
add - Boolean
update - Boolean
delete - Boolean
Example
{"add": true, "update": false, "delete": true}

GenerateQueryParams

Fields
Input Field Description
get - Boolean
query - Boolean
password - Boolean
aggregate - Boolean
Example
{"get": false, "query": false, "password": true, "aggregate": true}

HTTPMethod

Values
Enum Value Description

GET

POST

PUT

PATCH

DELETE

Example
"GET"

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987

IntersectsFilter

Fields
Input Field Description
polygon - PolygonRef
multiPolygon - MultiPolygonRef
Example
{
  "polygon": PolygonRef,
  "multiPolygon": MultiPolygonRef
}

Match

Fields
Field Name Description
id - ID!
coverageSearch - Float!
coverageMatch - Float!
matchRatio - Float!
matchSet - [MatchSet!]
Arguments
filter - MatchSetFilter
order - MatchSetOrder
first - Int!
offset - Int!
search - Search!
Arguments
filter - SearchFilter
createdAt - DateTime!
matchSetAggregate - MatchSetAggregateResult
Arguments
filter - MatchSetFilter
Example
{
  "id": "4",
  "coverageSearch": 987.65,
  "coverageMatch": 123.45,
  "matchRatio": 123.45,
  "matchSet": [MatchSet],
  "search": Search,
  "createdAt": "2007-12-03T10:15:30Z",
  "matchSetAggregate": MatchSetAggregateResult
}

MatchAggregateResult

Fields
Field Name Description
count - Int
coverageSearchMin - Float
coverageSearchMax - Float
coverageSearchSum - Float
coverageSearchAvg - Float
coverageMatchMin - Float
coverageMatchMax - Float
coverageMatchSum - Float
coverageMatchAvg - Float
matchRatioMin - Float
matchRatioMax - Float
matchRatioSum - Float
matchRatioAvg - Float
createdAtMin - DateTime
createdAtMax - DateTime
Example
{
  "count": 987,
  "coverageSearchMin": 123.45,
  "coverageSearchMax": 987.65,
  "coverageSearchSum": 987.65,
  "coverageSearchAvg": 123.45,
  "coverageMatchMin": 123.45,
  "coverageMatchMax": 123.45,
  "coverageMatchSum": 987.65,
  "coverageMatchAvg": 123.45,
  "matchRatioMin": 987.65,
  "matchRatioMax": 123.45,
  "matchRatioSum": 123.45,
  "matchRatioAvg": 987.65,
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}

MatchFilter

Fields
Input Field Description
id - [ID!]
createdAt - DateTimeFilter
has - [MatchHasFilter]
and - [MatchFilter]
or - [MatchFilter]
not - MatchFilter
Example
{
  "id": [4],
  "createdAt": DateTimeFilter,
  "has": ["coverageSearch"],
  "and": [MatchFilter],
  "or": [MatchFilter],
  "not": MatchFilter
}

MatchHasFilter

Values
Enum Value Description

coverageSearch

coverageMatch

matchRatio

matchSet

search

createdAt

Example
"coverageSearch"

MatchOrder

Fields
Input Field Description
asc - MatchOrderable
desc - MatchOrderable
then - MatchOrder
Example
{
  "asc": "coverageSearch",
  "desc": "coverageSearch",
  "then": MatchOrder
}

MatchOrderable

Values
Enum Value Description

coverageSearch

coverageMatch

matchRatio

createdAt

Example
"coverageSearch"

MatchRef

Fields
Input Field Description
id - ID
coverageSearch - Float
coverageMatch - Float
matchRatio - Float
matchSet - [MatchSetRef!]
search - SearchRef
createdAt - DateTime
Example
{
  "id": 4,
  "coverageSearch": 123.45,
  "coverageMatch": 987.65,
  "matchRatio": 123.45,
  "matchSet": [MatchSetRef],
  "search": SearchRef,
  "createdAt": "2007-12-03T10:15:30Z"
}

MatchSet

Fields
Field Name Description
id - ID!
search - Search!
Arguments
filter - SearchFilter
tags - [Tag!]!
Arguments
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!
matches - [Match!]
Arguments
filter - MatchFilter
order - MatchOrder
first - Int!
offset - Int!
minCoverageSearch - Float
minCoverageMatch - Float
matchFactor - Float!
createdAt - DateTime!
state - State!
tagsAggregate - TagAggregateResult
Arguments
filter - TagFilter
matchesAggregate - MatchAggregateResult
Arguments
filter - MatchFilter
Example
{
  "id": "4",
  "search": Search,
  "tags": [Tag],
  "matches": [Match],
  "minCoverageSearch": 987.65,
  "minCoverageMatch": 987.65,
  "matchFactor": 123.45,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW",
  "tagsAggregate": TagAggregateResult,
  "matchesAggregate": MatchAggregateResult
}

MatchSetAggregateResult

Fields
Field Name Description
count - Int
minCoverageSearchMin - Float
minCoverageSearchMax - Float
minCoverageSearchSum - Float
minCoverageSearchAvg - Float
minCoverageMatchMin - Float
minCoverageMatchMax - Float
minCoverageMatchSum - Float
minCoverageMatchAvg - Float
matchFactorMin - Float
matchFactorMax - Float
matchFactorSum - Float
matchFactorAvg - Float
createdAtMin - DateTime
createdAtMax - DateTime
Example
{
  "count": 987,
  "minCoverageSearchMin": 987.65,
  "minCoverageSearchMax": 987.65,
  "minCoverageSearchSum": 987.65,
  "minCoverageSearchAvg": 987.65,
  "minCoverageMatchMin": 123.45,
  "minCoverageMatchMax": 987.65,
  "minCoverageMatchSum": 987.65,
  "minCoverageMatchAvg": 987.65,
  "matchFactorMin": 123.45,
  "matchFactorMax": 123.45,
  "matchFactorSum": 123.45,
  "matchFactorAvg": 987.65,
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}

MatchSetFilter

Fields
Input Field Description
id - [ID!]
createdAt - DateTimeFilter
state - State_hash
has - [MatchSetHasFilter]
and - [MatchSetFilter]
or - [MatchSetFilter]
not - MatchSetFilter
Example
{
  "id": [4],
  "createdAt": DateTimeFilter,
  "state": State_hash,
  "has": ["search"],
  "and": [MatchSetFilter],
  "or": [MatchSetFilter],
  "not": MatchSetFilter
}

MatchSetHasFilter

Values
Enum Value Description

search

tags

matches

minCoverageSearch

minCoverageMatch

matchFactor

createdAt

state

Example
"search"

MatchSetOrder

Fields
Input Field Description
asc - MatchSetOrderable
desc - MatchSetOrderable
then - MatchSetOrder
Example
{
  "asc": "minCoverageSearch",
  "desc": "minCoverageSearch",
  "then": MatchSetOrder
}

MatchSetOrderable

Values
Enum Value Description

minCoverageSearch

minCoverageMatch

matchFactor

createdAt

Example
"minCoverageSearch"

MatchSetPatch

Fields
Input Field Description
search - SearchRef
tags - [TagRef!]
matches - [MatchRef!]
minCoverageSearch - Float
minCoverageMatch - Float
matchFactor - Float
createdAt - DateTime
state - State
Example
{
  "search": SearchRef,
  "tags": [TagRef],
  "matches": [MatchRef],
  "minCoverageSearch": 987.65,
  "minCoverageMatch": 123.45,
  "matchFactor": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW"
}

MatchSetRef

Fields
Input Field Description
id - ID
search - SearchRef
tags - [TagRef!]
matches - [MatchRef!]
minCoverageSearch - Float
minCoverageMatch - Float
matchFactor - Float
createdAt - DateTime
state - State
Example
{
  "id": 4,
  "search": SearchRef,
  "tags": [TagRef],
  "matches": [MatchRef],
  "minCoverageSearch": 987.65,
  "minCoverageMatch": 123.45,
  "matchFactor": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW"
}

MergeSet

Fields
Field Name Description
id - ID!
tags - [Tag!]!
Arguments
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!
baseSearchSet - SearchSet! SearchSet which got used as base for MergeSet
Arguments
filter - SearchSetFilter
mergeSearchSet - SearchSet! SearchSet which got merged with base in MergeSet
Arguments
filter - SearchSetFilter
searchSet - SearchSet
Arguments
filter - SearchSetFilter
createdAt - DateTime!
savedDistance - Float!
state - State!
tagsAggregate - TagAggregateResult
Arguments
filter - TagFilter
Example
{
  "id": 4,
  "tags": [Tag],
  "baseSearchSet": SearchSet,
  "mergeSearchSet": SearchSet,
  "searchSet": SearchSet,
  "createdAt": "2007-12-03T10:15:30Z",
  "savedDistance": 987.65,
  "state": "NEW",
  "tagsAggregate": TagAggregateResult
}

MergeSetAggregateResult

Fields
Field Name Description
count - Int
createdAtMin - DateTime
createdAtMax - DateTime
savedDistanceMin - Float
savedDistanceMax - Float
savedDistanceSum - Float
savedDistanceAvg - Float
Example
{
  "count": 123,
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "savedDistanceMin": 123.45,
  "savedDistanceMax": 987.65,
  "savedDistanceSum": 987.65,
  "savedDistanceAvg": 987.65
}

MergeSetFilter

Fields
Input Field Description
id - [ID!]
createdAt - DateTimeFilter
state - State_hash
has - [MergeSetHasFilter]
and - [MergeSetFilter]
or - [MergeSetFilter]
not - MergeSetFilter
Example
{
  "id": ["4"],
  "createdAt": DateTimeFilter,
  "state": State_hash,
  "has": ["tags"],
  "and": [MergeSetFilter],
  "or": [MergeSetFilter],
  "not": MergeSetFilter
}

MergeSetHasFilter

Values
Enum Value Description

tags

baseSearchSet

mergeSearchSet

searchSet

createdAt

savedDistance

state

Example
"tags"

MergeSetOrder

Fields
Input Field Description
asc - MergeSetOrderable
desc - MergeSetOrderable
then - MergeSetOrder
Example
{
  "asc": "createdAt",
  "desc": "createdAt",
  "then": MergeSetOrder
}

MergeSetOrderable

Values
Enum Value Description

createdAt

savedDistance

Example
"createdAt"

MergeSetPatch

Fields
Input Field Description
tags - [TagRef!]
baseSearchSet - SearchSetRef
mergeSearchSet - SearchSetRef
searchSet - SearchSetRef
createdAt - DateTime
savedDistance - Float
state - State
Example
{
  "tags": [TagRef],
  "baseSearchSet": SearchSetRef,
  "mergeSearchSet": SearchSetRef,
  "searchSet": SearchSetRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "savedDistance": 123.45,
  "state": "NEW"
}

MergeSetRef

Fields
Input Field Description
id - ID
tags - [TagRef!]
baseSearchSet - SearchSetRef
mergeSearchSet - SearchSetRef
searchSet - SearchSetRef
createdAt - DateTime
savedDistance - Float
state - State
Example
{
  "id": 4,
  "tags": [TagRef],
  "baseSearchSet": SearchSetRef,
  "mergeSearchSet": SearchSetRef,
  "searchSet": SearchSetRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "savedDistance": 123.45,
  "state": "NEW"
}

Mode

Values
Enum Value Description

BATCH

SINGLE

Example
"BATCH"

MultiPolygonRef

Fields
Input Field Description
polygons - [PolygonRef!]!
Example
{"polygons": [PolygonRef]}

NearFilter

Fields
Input Field Description
distance - Float!
coordinate - PointRef!
Example
{"distance": 987.65, "coordinate": PointRef}

Point

Fields
Field Name Description
longitude - Float!
latitude - Float!
Example
{"longitude": 987.65, "latitude": 987.65}

PointGeoFilter

Fields
Input Field Description
near - NearFilter
within - WithinFilter
Example
{
  "near": NearFilter,
  "within": WithinFilter
}

PointList

Fields
Field Name Description
points - [Point!]!
Example
{"points": [Point]}

PointListRef

Fields
Input Field Description
points - [PointRef!]!
Example
{"points": [PointRef]}

PointRef

Fields
Input Field Description
longitude - Float!
latitude - Float!
Example
{"longitude": 123.45, "latitude": 123.45}

Polygon

Fields
Field Name Description
coordinates - [PointList!]!
Example
{"coordinates": [PointList]}

PolygonGeoFilter

Fields
Input Field Description
near - NearFilter
within - WithinFilter
contains - ContainsFilter
intersects - IntersectsFilter
Example
{
  "near": NearFilter,
  "within": WithinFilter,
  "contains": ContainsFilter,
  "intersects": IntersectsFilter
}

PolygonRef

Fields
Input Field Description
coordinates - [PointListRef!]!
Example
{"coordinates": [PointListRef]}

Prediction

Fields
Field Name Description
description - String!
Example
{"description": "abc123"}

PredictionAggregateResult

Fields
Field Name Description
count - Int
descriptionMin - String
descriptionMax - String
Example
{
  "count": 123,
  "descriptionMin": "xyz789",
  "descriptionMax": "abc123"
}

PredictionFilter

Fields
Input Field Description
has - [PredictionHasFilter]
and - [PredictionFilter]
or - [PredictionFilter]
not - PredictionFilter
Example
{
  "has": ["description"],
  "and": [PredictionFilter],
  "or": [PredictionFilter],
  "not": PredictionFilter
}

PredictionHasFilter

Values
Enum Value Description

description

Example
"description"

PredictionOrder

Fields
Input Field Description
asc - PredictionOrderable
desc - PredictionOrderable
then - PredictionOrder
Example
{
  "asc": "description",
  "desc": "description",
  "then": PredictionOrder
}

PredictionOrderable

Values
Enum Value Description

description

Example
"description"

PredictionPatch

Fields
Input Field Description
description - String
Example
{"description": "xyz789"}

Predictions

Fields
Field Name Description
predictions - [Prediction!]
Example
{"predictions": [Prediction]}

SearchAggregateResult

Fields
Field Name Description
count - Int
idMin - String
idMax - String
distanceMin - Float
distanceMax - Float
distanceSum - Float
distanceAvg - Float
createdAtMin - DateTime
createdAtMax - DateTime
Example
{
  "count": 123,
  "idMin": "xyz789",
  "idMax": "xyz789",
  "distanceMin": 123.45,
  "distanceMax": 123.45,
  "distanceSum": 123.45,
  "distanceAvg": 123.45,
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}

SearchFilter

Fields
Input Field Description
id - StringHashFilter
startPoint - PointGeoFilter
destinationPoint - PointGeoFilter
polygonLine - PolygonGeoFilter
active - Boolean
createdAt - DateTimeFilter
has - [SearchHasFilter]
and - [SearchFilter]
or - [SearchFilter]
not - SearchFilter
Example
{
  "id": StringHashFilter,
  "startPoint": PointGeoFilter,
  "destinationPoint": PointGeoFilter,
  "polygonLine": PolygonGeoFilter,
  "active": false,
  "createdAt": DateTimeFilter,
  "has": ["id"],
  "and": [SearchFilter],
  "or": [SearchFilter],
  "not": SearchFilter
}

SearchHasFilter

Values
Enum Value Description

id

searchSet

startPoint

destinationPoint

waypoints

polygonLine

active

distance

lineString

createdAt

tags

matchSets

Example
"id"

SearchOrder

Fields
Input Field Description
asc - SearchOrderable
desc - SearchOrderable
then - SearchOrder
Example
{"asc": "id", "desc": "id", "then": SearchOrder}

SearchOrderable

Values
Enum Value Description

id

distance

createdAt

Example
"id"

SearchPatch

Fields
Input Field Description
id - String
searchSet - SearchSetRef
startPoint - PointRef
destinationPoint - PointRef
waypoints - [WaypointRef]
polygonLine - PolygonRef
active - Boolean
distance - Float
lineString - PolygonRef
createdAt - DateTime
tags - [TagRef!]
matchSets - [MatchSetRef!]
Example
{
  "id": "abc123",
  "searchSet": SearchSetRef,
  "startPoint": PointRef,
  "destinationPoint": PointRef,
  "waypoints": [WaypointRef],
  "polygonLine": PolygonRef,
  "active": false,
  "distance": 987.65,
  "lineString": PolygonRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "tags": [TagRef],
  "matchSets": [MatchSetRef]
}

SearchRef

Fields
Input Field Description
id - String
searchSet - SearchSetRef
startPoint - PointRef
destinationPoint - PointRef
waypoints - [WaypointRef]
polygonLine - PolygonRef
active - Boolean
distance - Float
lineString - PolygonRef
createdAt - DateTime
tags - [TagRef!]
matchSets - [MatchSetRef!]
Example
{
  "id": "abc123",
  "searchSet": SearchSetRef,
  "startPoint": PointRef,
  "destinationPoint": PointRef,
  "waypoints": [WaypointRef],
  "polygonLine": PolygonRef,
  "active": true,
  "distance": 987.65,
  "lineString": PolygonRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "tags": [TagRef],
  "matchSets": [MatchSetRef]
}

SearchSet

Fields
Field Name Description
id - ID!
searches - [Search!]
Arguments
filter - SearchFilter
order - SearchOrder
first - Int!
offset - Int!
tags - [Tag!]!
Arguments
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!
start - String!
destination - String!
baseMergeSet - MergeSet MergeSet in which this search is the base for the merge
Arguments
filter - MergeSetFilter
mergeMergeSet - MergeSet MergeSet in which this search got merged with the base
Arguments
filter - MergeSetFilter
mergeSet - MergeSet SearchSet that got created based on merge request
Arguments
filter - MergeSetFilter
active - Boolean!
createdAt - DateTime!
state - State!
searchesAggregate - SearchAggregateResult
Arguments
filter - SearchFilter
tagsAggregate - TagAggregateResult
Arguments
filter - TagFilter
Example
{
  "id": 4,
  "searches": [Search],
  "tags": [Tag],
  "start": "abc123",
  "destination": "abc123",
  "baseMergeSet": MergeSet,
  "mergeMergeSet": MergeSet,
  "mergeSet": MergeSet,
  "active": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW",
  "searchesAggregate": SearchAggregateResult,
  "tagsAggregate": TagAggregateResult
}

SearchSetAggregateResult

Fields
Field Name Description
count - Int
startMin - String
startMax - String
destinationMin - String
destinationMax - String
createdAtMin - DateTime
createdAtMax - DateTime
Example
{
  "count": 123,
  "startMin": "xyz789",
  "startMax": "xyz789",
  "destinationMin": "abc123",
  "destinationMax": "xyz789",
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}

SearchSetFilter

Fields
Input Field Description
id - [ID!]
start - StringTermFilter
destination - StringTermFilter
active - Boolean
createdAt - DateTimeFilter
state - State_hash
has - [SearchSetHasFilter]
and - [SearchSetFilter]
or - [SearchSetFilter]
not - SearchSetFilter
Example
{
  "id": ["4"],
  "start": StringTermFilter,
  "destination": StringTermFilter,
  "active": false,
  "createdAt": DateTimeFilter,
  "state": State_hash,
  "has": ["searches"],
  "and": [SearchSetFilter],
  "or": [SearchSetFilter],
  "not": SearchSetFilter
}

SearchSetHasFilter

Values
Enum Value Description

searches

tags

start

destination

baseMergeSet

mergeMergeSet

mergeSet

active

createdAt

state

Example
"searches"

SearchSetOrder

Fields
Input Field Description
asc - SearchSetOrderable
desc - SearchSetOrderable
then - SearchSetOrder
Example
{"asc": "start", "desc": "start", "then": SearchSetOrder}

SearchSetOrderable

Values
Enum Value Description

start

destination

createdAt

Example
"start"

SearchSetPatch

Fields
Input Field Description
searches - [SearchRef!]
tags - [TagRef!]
start - String
destination - String
baseMergeSet - MergeSetRef
mergeMergeSet - MergeSetRef
mergeSet - MergeSetRef
active - Boolean
createdAt - DateTime
state - State
Example
{
  "searches": [SearchRef],
  "tags": [TagRef],
  "start": "xyz789",
  "destination": "xyz789",
  "baseMergeSet": MergeSetRef,
  "mergeMergeSet": MergeSetRef,
  "mergeSet": MergeSetRef,
  "active": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW"
}

SearchSetRef

Fields
Input Field Description
id - ID
searches - [SearchRef!]
tags - [TagRef!]
start - String
destination - String
baseMergeSet - MergeSetRef
mergeMergeSet - MergeSetRef
mergeSet - MergeSetRef
active - Boolean
createdAt - DateTime
state - State
Example
{
  "id": "4",
  "searches": [SearchRef],
  "tags": [TagRef],
  "start": "abc123",
  "destination": "xyz789",
  "baseMergeSet": MergeSetRef,
  "mergeMergeSet": MergeSetRef,
  "mergeSet": MergeSetRef,
  "active": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW"
}

State

Values
Enum Value Description

NEW

PROCESSED

ERROR

PAYMENT_ERROR

NORESULT

PROCESSING

Example
"NEW"

State_hash

Fields
Input Field Description
eq - State
in - [State]
Example
{"eq": "NEW", "in": ["NEW"]}

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"

StringHashFilter

Fields
Input Field Description
eq - String
in - [String]
Example
{
  "eq": "xyz789",
  "in": ["xyz789"]
}

StringTermFilter

Fields
Input Field Description
allofterms - String
anyofterms - String
Example
{
  "allofterms": "abc123",
  "anyofterms": "abc123"
}

Tag

Fields
Field Name Description
id - ID!
name - String!
users - [User!]!
Arguments
filter - UserFilter
order - UserOrder
first - Int!
offset - Int!
searchSets - [SearchSet]
Arguments
filter - SearchSetFilter
order - SearchSetOrder
first - Int!
offset - Int!
mergeSets - [MergeSet]
Arguments
filter - MergeSetFilter
order - MergeSetOrder
first - Int!
offset - Int!
matchSets - [MatchSet]
Arguments
filter - MatchSetFilter
order - MatchSetOrder
first - Int!
offset - Int!
searches - [Search!]
Arguments
filter - SearchFilter
order - SearchOrder
first - Int!
offset - Int!
createdAt - DateTime!
usersAggregate - UserAggregateResult
Arguments
filter - UserFilter
searchSetsAggregate - SearchSetAggregateResult
Arguments
filter - SearchSetFilter
mergeSetsAggregate - MergeSetAggregateResult
Arguments
filter - MergeSetFilter
matchSetsAggregate - MatchSetAggregateResult
Arguments
filter - MatchSetFilter
searchesAggregate - SearchAggregateResult
Arguments
filter - SearchFilter
Example
{
  "id": 4,
  "name": "abc123",
  "users": [User],
  "searchSets": [SearchSet],
  "mergeSets": [MergeSet],
  "matchSets": [MatchSet],
  "searches": [Search],
  "createdAt": "2007-12-03T10:15:30Z",
  "usersAggregate": UserAggregateResult,
  "searchSetsAggregate": SearchSetAggregateResult,
  "mergeSetsAggregate": MergeSetAggregateResult,
  "matchSetsAggregate": MatchSetAggregateResult,
  "searchesAggregate": SearchAggregateResult
}

TagAggregateResult

Fields
Field Name Description
count - Int
nameMin - String
nameMax - String
createdAtMin - DateTime
createdAtMax - DateTime
Example
{
  "count": 987,
  "nameMin": "xyz789",
  "nameMax": "abc123",
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}

TagFilter

Fields
Input Field Description
id - [ID!]
createdAt - DateTimeFilter
has - [TagHasFilter]
and - [TagFilter]
or - [TagFilter]
not - TagFilter
Example
{
  "id": ["4"],
  "createdAt": DateTimeFilter,
  "has": ["name"],
  "and": [TagFilter],
  "or": [TagFilter],
  "not": TagFilter
}

TagHasFilter

Values
Enum Value Description

name

users

searchSets

mergeSets

matchSets

searches

createdAt

Example
"name"

TagOrder

Fields
Input Field Description
asc - TagOrderable
desc - TagOrderable
then - TagOrder
Example
{"asc": "name", "desc": "name", "then": TagOrder}

TagOrderable

Values
Enum Value Description

name

createdAt

Example
"name"

TagPatch

Fields
Input Field Description
name - String
users - [UserRef!]
searchSets - [SearchSetRef]
mergeSets - [MergeSetRef]
matchSets - [MatchSetRef]
searches - [SearchRef!]
createdAt - DateTime
Example
{
  "name": "abc123",
  "users": [UserRef],
  "searchSets": [SearchSetRef],
  "mergeSets": [MergeSetRef],
  "matchSets": [MatchSetRef],
  "searches": [SearchRef],
  "createdAt": "2007-12-03T10:15:30Z"
}

TagRef

Fields
Input Field Description
id - ID
name - String
users - [UserRef!]
searchSets - [SearchSetRef]
mergeSets - [MergeSetRef]
matchSets - [MatchSetRef]
searches - [SearchRef!]
createdAt - DateTime
Example
{
  "id": 4,
  "name": "abc123",
  "users": [UserRef],
  "searchSets": [SearchSetRef],
  "mergeSets": [MergeSetRef],
  "matchSets": [MatchSetRef],
  "searches": [SearchRef],
  "createdAt": "2007-12-03T10:15:30Z"
}

UpdateMatchSetInput

Fields
Input Field Description
filter - MatchSetFilter!
set - MatchSetPatch
remove - MatchSetPatch
Example
{
  "filter": MatchSetFilter,
  "set": MatchSetPatch,
  "remove": MatchSetPatch
}

UpdateMatchSetPayload

Fields
Field Name Description
matchSet - [MatchSet]
Arguments
filter - MatchSetFilter
order - MatchSetOrder
first - Int!
offset - Int!
numUids - Int
Example
{"matchSet": [MatchSet], "numUids": 987}

UpdateMergeSetInput

Fields
Input Field Description
filter - MergeSetFilter!
set - MergeSetPatch
remove - MergeSetPatch
Example
{
  "filter": MergeSetFilter,
  "set": MergeSetPatch,
  "remove": MergeSetPatch
}

UpdateMergeSetPayload

Fields
Field Name Description
mergeSet - [MergeSet]
Arguments
filter - MergeSetFilter
order - MergeSetOrder
first - Int!
offset - Int!
numUids - Int
Example
{"mergeSet": [MergeSet], "numUids": 123}

UpdatePredictionInput

Fields
Input Field Description
filter - PredictionFilter!
set - PredictionPatch
remove - PredictionPatch
Example
{
  "filter": PredictionFilter,
  "set": PredictionPatch,
  "remove": PredictionPatch
}

UpdatePredictionPayload

Fields
Field Name Description
prediction - [Prediction]
Arguments
filter - PredictionFilter
order - PredictionOrder
first - Int!
offset - Int!
numUids - Int
Example
{"prediction": [Prediction], "numUids": 123}

UpdateSearchInput

Fields
Input Field Description
filter - SearchFilter!
set - SearchPatch
remove - SearchPatch
Example
{
  "filter": SearchFilter,
  "set": SearchPatch,
  "remove": SearchPatch
}

UpdateSearchPayload

Fields
Field Name Description
search - [Search]
Arguments
filter - SearchFilter
order - SearchOrder
first - Int!
offset - Int!
numUids - Int
Example
{"search": [Search], "numUids": 987}

UpdateSearchSetInput

Fields
Input Field Description
filter - SearchSetFilter!
set - SearchSetPatch
remove - SearchSetPatch
Example
{
  "filter": SearchSetFilter,
  "set": SearchSetPatch,
  "remove": SearchSetPatch
}

UpdateSearchSetPayload

Fields
Field Name Description
searchSet - [SearchSet]
Arguments
filter - SearchSetFilter
order - SearchSetOrder
first - Int!
offset - Int!
numUids - Int
Example
{"searchSet": [SearchSet], "numUids": 987}

UpdateTagInput

Fields
Input Field Description
filter - TagFilter!
set - TagPatch
remove - TagPatch
Example
{
  "filter": TagFilter,
  "set": TagPatch,
  "remove": TagPatch
}

UpdateTagPayload

Fields
Field Name Description
tag - [Tag]
Arguments
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!
numUids - Int
Example
{"tag": [Tag], "numUids": 123}

UpdateUserInput

Fields
Input Field Description
filter - UserFilter!
set - UserPatch
remove - UserPatch
Example
{
  "filter": UserFilter,
  "set": UserPatch,
  "remove": UserPatch
}

UpdateUserPayload

Fields
Field Name Description
user - [User]
Arguments
filter - UserFilter
order - UserOrder
first - Int!
offset - Int!
numUids - Int
Example
{"user": [User], "numUids": 123}

User

Fields
Field Name Description
id - String!
email - String!
tags - [Tag!]
Arguments
filter - TagFilter
order - TagOrder
first - Int!
offset - Int!
tagsAggregate - TagAggregateResult
Arguments
filter - TagFilter
Example
{
  "id": "abc123",
  "email": "xyz789",
  "tags": [Tag],
  "tagsAggregate": TagAggregateResult
}

UserAggregateResult

Fields
Field Name Description
count - Int
idMin - String
idMax - String
emailMin - String
emailMax - String
Example
{
  "count": 987,
  "idMin": "abc123",
  "idMax": "abc123",
  "emailMin": "abc123",
  "emailMax": "abc123"
}

UserFilter

Fields
Input Field Description
id - StringHashFilter
email - StringHashFilter
has - [UserHasFilter]
and - [UserFilter]
or - [UserFilter]
not - UserFilter
Example
{
  "id": StringHashFilter,
  "email": StringHashFilter,
  "has": ["id"],
  "and": [UserFilter],
  "or": [UserFilter],
  "not": UserFilter
}

UserHasFilter

Values
Enum Value Description

id

email

tags

Example
"id"

UserOrder

Fields
Input Field Description
asc - UserOrderable
desc - UserOrderable
then - UserOrder
Example
{"asc": "id", "desc": "id", "then": UserOrder}

UserOrderable

Values
Enum Value Description

id

email

Example
"id"

UserPatch

Fields
Input Field Description
id - String
email - String
tags - [TagRef!]
Example
{
  "id": "xyz789",
  "email": "xyz789",
  "tags": [TagRef]
}

UserRef

Fields
Input Field Description
id - String
email - String
tags - [TagRef!]
Example
{
  "id": "abc123",
  "email": "xyz789",
  "tags": [TagRef]
}

Waypoint

Fields
Field Name Description
id - String!
value - String!
sortOrder - Int!
marker - Point!
search - Search!
Arguments
filter - SearchFilter
Example
{
  "id": "xyz789",
  "value": "abc123",
  "sortOrder": 987,
  "marker": Point,
  "search": Search
}

WaypointAggregateResult

Fields
Field Name Description
count - Int
idMin - String
idMax - String
valueMin - String
valueMax - String
sortOrderMin - Int
sortOrderMax - Int
sortOrderSum - Int
sortOrderAvg - Float
Example
{
  "count": 987,
  "idMin": "xyz789",
  "idMax": "abc123",
  "valueMin": "abc123",
  "valueMax": "xyz789",
  "sortOrderMin": 123,
  "sortOrderMax": 123,
  "sortOrderSum": 987,
  "sortOrderAvg": 123.45
}

WaypointFilter

Fields
Input Field Description
id - StringHashFilter
marker - PointGeoFilter
has - [WaypointHasFilter]
and - [WaypointFilter]
or - [WaypointFilter]
not - WaypointFilter
Example
{
  "id": StringHashFilter,
  "marker": PointGeoFilter,
  "has": ["id"],
  "and": [WaypointFilter],
  "or": [WaypointFilter],
  "not": WaypointFilter
}

WaypointHasFilter

Values
Enum Value Description

id

value

sortOrder

marker

search

Example
"id"

WaypointOrder

Fields
Input Field Description
asc - WaypointOrderable
desc - WaypointOrderable
then - WaypointOrder
Example
{"asc": "id", "desc": "id", "then": WaypointOrder}

WaypointOrderable

Values
Enum Value Description

id

value

sortOrder

Example
"id"

WaypointRef

Fields
Input Field Description
id - String
value - String
sortOrder - Int
marker - PointRef
search - SearchRef
Example
{
  "id": "xyz789",
  "value": "abc123",
  "sortOrder": 123,
  "marker": PointRef,
  "search": SearchRef
}

WithinFilter

Fields
Input Field Description
polygon - PolygonRef!
Example
{"polygon": PolygonRef}