Ecoroute

https://docs.ecoroute.io
Admin
Ecoroute is a GraphQL API platform that provides tools for managing searches, predictions, and route...
Tokens:97,292
Snippets:394
Trust Score:2.1
Update:8 months ago
Show doc for...
Tokens:
Raw
### GenerateQueryParams Example

Source: https://docs.ecoroute.io/index

Demonstrates parameters for generating queries, including options for get, query, password, and aggregation.

```json
{"get": false, "query": false, "password": true, "aggregate": false}
```

--------------------------------

### AddSearchSetInput Example

Source: https://docs.ecoroute.io/index

Example of the AddSearchSetInput object, used to define a new search set. It includes fields for searches, tags, start and destination locations, merge set configurations, and activation status.

```json
{
  "searches": [SearchRef],
  "tags": [TagRef],
  "start": "xyz789",
  "destination": "abc123",
  "baseMergeSet": MergeSetRef,
  "mergeMergeSet": MergeSetRef,
  "mergeSet": MergeSetRef,
  "active": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW",
  "dispatchDateTime": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### AddSearchInput Example

Source: https://docs.ecoroute.io/index

Example input for creating a new search. This includes a unique ID, search set reference, start and destination points, waypoints, polygon line, active status, distance, line string geometry, creation timestamp, tags, and associated match sets.

```json
{
  "id": "xyz789",
  "searchSet": SearchSetRef,
  "startPoint": PointRef,
  "destinationPoint": PointRef,
  "waypoints": [WaypointRef],
  "polygonLine": PolygonRef,
  "active": true,
  "distance": 123.45,
  "lineString": PolygonRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "tags": [TagRef],
  "matchSets": [MatchSetRef]
}
```

--------------------------------

### AddUserPayload Example

Source: https://docs.ecoroute.io/index

Example of the AddUserPayload, returned after successfully adding a user. It contains the created user and the number of unique identifiers processed.

```json
{
  "user": [User],
  "numUids": 123
}
```

--------------------------------

### MatchSet Example (General)

Source: https://docs.ecoroute.io/index

A general example of a MatchSet object, illustrating its structure and fields. This includes identifiers, search and tag information, coverage metrics, and timestamps.

```json
{
  "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",
  "dispatchDateTime": DispatchDateTimeFilter,
  "tagsAggregate": TagAggregateResult,
  "matchesAggregate": MatchAggregateResult
}
```

--------------------------------

### AddTagPayload Example

Source: https://docs.ecoroute.io/index

Example of the AddTagPayload, returned after successfully adding a tag. It contains the created tag and the number of unique identifiers processed.

```json
{
  "tag": [Tag],
  "numUids": 123
}
```

--------------------------------

### Add Search Set using cURL

Source: https://docs.ecoroute.io/index

This example demonstrates how to add a new search set, defining start and destination points, associated tags, creation timestamp, and state. It uses a GraphQL mutation and requires an API token.

```shell
$ 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"
    }
}'
```

--------------------------------

### AddUserInput Example

Source: https://docs.ecoroute.io/index

Example of the AddUserInput object, used for creating a new user. It requires a user ID, email address, and can optionally include associated tags.

```json
{
  "id": "abc123",
  "email": "abc123",
  "tags": [TagRef]
}
```

--------------------------------

### AddSearchSetPayload Example

Source: https://docs.ecoroute.io/index

Example of the AddSearchSetPayload, returned after successfully adding a search set. It contains the created search set and the number of unique identifiers processed.

```json
{
  "searchSet": [SearchSet],
  "numUids": 123
}
```

--------------------------------

### String Example

Source: https://docs.ecoroute.io/index

A basic example of the String scalar type, representing textual data. This is commonly used for fields like location names or identifiers.

```json
"abc123"

```

--------------------------------

### Example Value for MergeSetOrderable

Source: https://docs.ecoroute.io/index

This string represents an example value for MergeSetOrderable, specifying a field by which MergeSets can be ordered.

```json
"createdAt"
```

--------------------------------

### User Patch Example

Source: https://docs.ecoroute.io/index

This example illustrates the structure of a UserPatch object, used for updating user information. It allows modification of the user's ID, email, and associated tags.

```json
{
  "id": "xyz789",
  "email": "xyz789",
  "tags": [TagRef]
}
```

--------------------------------

### User Data Structure Example

Source: https://docs.ecoroute.io/index

This example demonstrates the structure of a User object, including its ID, email, associated tags, and aggregate tag information. It serves as a reference for how user data is represented.

```json
{
  "id": "abc123",
  "email": "xyz789",
  "tags": [Tag],
  "tagsAggregate": TagAggregateResult
}
```

--------------------------------

### MatchSetFilter Example

Source: https://docs.ecoroute.io/index

An example demonstrating the structure of a MatchSetFilter, used for querying MatchSets. It supports filtering by ID, creation date, state, and nested filtering with AND, OR, and NOT operators.

```json
{
  "id": ["4"],
  "createdAt": DateTimeFilter,
  "state": State_hash,
  "has": ["search"],
  "and": [MatchSetFilter],
  "or": [MatchSetFilter],
  "not": MatchSetFilter
}
```

--------------------------------

### AuthRule Example

Source: https://docs.ecoroute.io/index

Example of an AuthRule object, used for defining authorization rules. It supports logical operations like AND, OR, NOT, and can specify a direct rule string.

```json
{
  "and": [AuthRule],
  "or": [AuthRule],
  "not": AuthRule,
  "rule": "abc123"
}
```

--------------------------------

### AddMatchInput Example (JSON)

Source: https://docs.ecoroute.io/index

An example of the AddMatchInput structure, used for creating or updating a match. It includes coverage details, match ratio, references to match sets and searches, and a creation timestamp.

```json
{
  "coverageSearch": 0.5,
  "coverageMatch": 0.7,
  "matchRatio": 0.8,
  "matchSet": ["MatchSetRef!"],
  "search": "SearchRef!",
  "createdAt": "2007-12-03T10:15:30Z"
}

```

--------------------------------

### AddMatchPayload Example

Source: https://docs.ecoroute.io/index

This is an example of the payload structure for adding a match. It requires a list of matches and an optional number of unique identifiers (numUids).

```json
{
  "match": [Match],
  "numUids": 987
}
```

--------------------------------

### MatchSetOrder Example

Source: https://docs.ecoroute.io/index

An example of the MatchSetOrder type, used for specifying sorting criteria for MatchSets. It allows ascending or descending order and chaining multiple sort conditions.

```json
{
  "asc": "minCoverageSearch",
  "desc": "minCoverageSearch",
  "then": MatchSetOrder
}
```

--------------------------------

### AddDispatchDateTimeFilterPayload Example (JSON)

Source: https://docs.ecoroute.io/index

An example of the AddDispatchDateTimeFilterPayload structure, returned after applying a dispatch date-time filter. It contains a list of dispatchDateTimeFilters and the number of UIDs affected.

```json
{
  "dispatchDateTimeFilter": ["DispatchDateTimeFilter"],
  "numUids": 987
}

```

--------------------------------

### DispatchDateTimeFilter Example

Source: https://docs.ecoroute.io/index

An example of DispatchDateTimeFilter, illustrating how to structure filters for dispatch date and time. It includes various comparison operators and logical combinations.

```json
{
  "eq": "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",
  "in": ["2007-12-03T10:15:30Z"],
  "between": DispatchDateTimeRange
}
```

--------------------------------

### MatchSetRef Example

Source: https://docs.ecoroute.io/index

An example of the MatchSetRef type, representing a reference to a MatchSet. It includes essential identifying information and key properties like coverage and state.

```json
{
  "id": "ID",
  "search": SearchRef,
  "tags": [TagRef],
  "matches": [MatchRef],
  "minCoverageSearch": 123.45,
  "minCoverageMatch": 123.45,
  "matchFactor": 123.45,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "State",
  "dispatchDateTime": DispatchDateTimeFilterRef
}
```

--------------------------------

### MatchSetAggregateResult Example

Source: https://docs.ecoroute.io/index

An example of the MatchSetAggregateResult type, which provides aggregated data for MatchSets. This includes counts, min/max/sum/average coverage and match factor, and date ranges.

```json
{
  "count": 123,
  "minCoverageSearchMin": 987.65,
  "minCoverageSearchMax": 123.45,
  "minCoverageSearchSum": 987.65,
  "minCoverageSearchAvg": 123.45,
  "minCoverageMatchMin": 123.45,
  "minCoverageMatchMax": 987.65,
  "minCoverageMatchSum": 123.45,
  "minCoverageMatchAvg": 123.45,
  "matchFactorMin": 987.65,
  "matchFactorMax": 987.65,
  "matchFactorSum": 123.45,
  "matchFactorAvg": 123.45,
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### Mode Enum Example

Source: https://docs.ecoroute.io/index

This example demonstrates the usage of the 'Mode' enum, which defines possible modes for operations. The available values are 'BATCH' and 'SINGLE', each representing a distinct operational mode.

```json
"BATCH"
```

--------------------------------

### State_hash Filter Example

Source: https://docs.ecoroute.io/index

Shows an example of the State_hash filter, used for querying entities based on their state. It supports equality checks (`eq`) and checking if the state is within a list of possibilities (`in`).

```json
{
  "eq": "NEW",
  "in": ["NEW"]
}
```

--------------------------------

### MatchSetOrderable Example

Source: https://docs.ecoroute.io/index

An example of the MatchSetOrderable enum, defining the fields that can be used for sorting MatchSets. Available options include coverage metrics and creation timestamp.

```json
"minCoverageSearch"
```

--------------------------------

### AddDispatchDateTimeRangePayload Example (JSON)

Source: https://docs.ecoroute.io/index

An example of the AddDispatchDateTimeRangePayload structure, returned after applying a dispatch date-time range filter. It includes a list of dispatchDateTimeRanges and the number of UIDs affected.

```json
{
  "dispatchDateTimeRange": ["DispatchDateTimeRange"],
  "numUids": 123
}

```

--------------------------------

### DispatchDateTimeFilter Example (Logical Operations)

Source: https://docs.ecoroute.io/index

Example of DispatchDateTimeFilter demonstrating logical operations like 'and', 'or', and 'not'. This allows for complex filtering criteria by combining simpler filters.

```json
{
  "has": ["eq"],
  "and": [DispatchDateTimeFilterFilter],
  "or": [DispatchDateTimeFilterFilter],
  "not": DispatchDateTimeFilterFilter
}
```

--------------------------------

### TagPatch Example

Source: https://docs.ecoroute.io/index

An example JSON object for 'TagPatch', used for updating existing tag information. It allows modification of fields like name, associated users, search sets, and creation timestamp.

```json
{
  "name": "abc123",
  "users": [UserRef],
  "searchSets": [SearchSetRef],
  "mergeSets": [MergeSetRef],
  "matchSets": [MatchSetRef],
  "searches": [SearchRef],
  "createdAt": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### User Aggregate Result Example

Source: https://docs.ecoroute.io/index

This example shows the structure of UserAggregateResult, which provides aggregated information about users, such as count and min/max values for ID and email. This is useful for summarizing user data.

```json
{
  "count": 987,
  "idMin": "abc123",
  "idMax": "abc123",
  "emailMin": "abc123",
  "emailMax": "abc123"
}
```

--------------------------------

### DispatchDateTimeRangeFilter Example

Source: https://docs.ecoroute.io/index

An example demonstrating the structure of a DispatchDateTimeRangeFilter, used for filtering based on date and time ranges. It supports logical operations like 'has', 'and', 'or', and 'not'.

```json
{
  "has": ["min"],
  "and": [DispatchDateTimeRangeFilter],
  "or": [DispatchDateTimeRangeFilter],
  "not": DispatchDateTimeRangeFilter
}
```

--------------------------------

### TagOrder Example

Source: https://docs.ecoroute.io/index

An example JSON object illustrating the 'TagOrder' structure, used for defining sorting criteria for tags. It supports ascending and descending order and chaining multiple order criteria.

```json
{"asc": "name", "desc": "name", "then": TagOrder}
```

--------------------------------

### Tag Object Example

Source: https://docs.ecoroute.io/index

An example of the Tag object, representing a label that can be associated with various entities. It includes the tag's ID, name, associated users, and related search and merge sets.

```json
{
  "id": "ID!",
  "name": "String!",
  "users": [User!],
  "searchSets": [SearchSet],
  "mergeSets": [MergeSet]
}
```

--------------------------------

### Match Example

Source: https://docs.ecoroute.io/index

Demonstrates the structure of a Match object, including details about coverage, ratio, associated match sets, search, creation time, and aggregates.

```json
{
  "id": 4,
  "coverageSearch": 123.45,
  "coverageMatch": 987.65,
  "matchRatio": 123.45,
  "matchSet": ["MatchSet"],
  "search": "Search",
  "createdAt": "2007-12-03T10:15:30Z",
  "matchSetAggregate": "MatchSetAggregateResult"
}
```

--------------------------------

### SearchSetRef Object Example

Source: https://docs.ecoroute.io/index

Illustrates the structure of a SearchSetRef object, which is a reference to a search set. It includes its unique identifier and various properties like start and destination locations, active status, and timestamps.

```json
{
  "id": "4",
  "searches": [SearchRef],
  "tags": [TagRef],
  "start": "xyz789",
  "destination": "abc123",
  "baseMergeSet": MergeSetRef,
  "mergeMergeSet": MergeSetRef,
  "mergeSet": MergeSetRef,
  "active": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW",
  "dispatchDateTime": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### AddMergeSetInput Example

Source: https://docs.ecoroute.io/index

Example input for creating a merge set. This requires tags, base and merge search set references, and optionally a search set reference. It also includes creation timestamp, saved distance, and the current state of the merge set.

```json
{
  "tags": [TagRef],
  "baseSearchSet": SearchSetRef,
  "mergeSearchSet": SearchSetRef,
  "searchSet": SearchSetRef,
  "createdAt": "2007-12-03T10:15:30Z",
  "savedDistance": 987.65,
  "state": "NEW"
}
```

--------------------------------

### ContainsFilter Example

Source: https://docs.ecoroute.io/index

Example of a ContainsFilter, used for spatial queries. It can filter based on a point or a polygon.

```json
{
  "point": PointRef,
  "polygon": PolygonRef
}
```

--------------------------------

### Boolean Type Example

Source: https://docs.ecoroute.io/index

Example of the Boolean scalar type, representing a true or false value.

```json
true
```

--------------------------------

### AddMatchSetInput Example

Source: https://docs.ecoroute.io/index

Example input for creating a new match set. This includes references to search and tags, along with coverage and match factor thresholds, creation timestamp, and state. It also allows for specifying a dispatch date-time filter.

```json
{
  "search": SearchRef,
  "tags": [TagRef],
  "matches": [MatchRef],
  "minCoverageSearch": 987.65,
  "minCoverageMatch": 987.65,
  "matchFactor": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW",
  "dispatchDateTime": DispatchDateTimeFilterRef
}
```

--------------------------------

### User Order Example

Source: https://docs.ecoroute.io/index

This example demonstrates the UserOrder object, used for specifying the sorting order of user query results. It supports ascending ('asc') and descending ('desc') orderings, and chaining multiple order criteria with 'then'.

```json
{"asc": "id", "desc": "id", "then": UserOrder}
```

--------------------------------

### AddPredictionInput Example

Source: https://docs.ecoroute.io/index

An example input payload for adding a prediction. The only required field is a description string.

```json
{
  "description": "xyz789"
}
```

--------------------------------

### HTTPMethod Enum Example

Source: https://docs.ecoroute.io/index

Provides an example of the HTTPMethod enum, representing standard HTTP request methods.

```json
"GET"
```

--------------------------------

### DateTime Type Example

Source: https://docs.ecoroute.io/index

Example of the DateTime scalar type, representing a date and time in RFC3339 format.

```json
"2007-12-03T10:15:30Z"
```

--------------------------------

### TagHasFilter Example

Source: https://docs.ecoroute.io/index

An example string value for 'TagHasFilter'. This enum is used to specify which attributes of a tag should be considered when filtering.

```json
"name"
```

--------------------------------

### Example Value for MergeSetHasFilter

Source: https://docs.ecoroute.io/index

This string represents an example value for MergeSetHasFilter, indicating which fields of a MergeSet should be included in the query results.

```json
"tags"
```

--------------------------------

### Float Scalar Type Example

Source: https://docs.ecoroute.io/index

Provides an example of the Float scalar type, representing a signed double-precision fractional number.

```json
123.45
```

--------------------------------

### PredictionHasFilter Enum Example

Source: https://docs.ecoroute.io/index

This example shows a value from the 'PredictionHasFilter' enum, specifying which field of a prediction to filter on. Currently, only 'description' is supported.

```json
"description"
```

--------------------------------

### FloatRange Example

Source: https://docs.ecoroute.io/index

Shows the structure for defining a range of Float values, specifying minimum and maximum bounds.

```json
{"min": 987.65, "max": 123.45}
```

--------------------------------

### DispatchDateTimeRangeHasFilter Example

Source: https://docs.ecoroute.io/index

Example of DispatchDateTimeRangeHasFilter, an enum used within range filters to indicate which part of the range is being filtered ('min' or 'max').

```json
"min"
```

--------------------------------

### Example Match Data Structure

Source: https://docs.ecoroute.io/index

Provides a sample JSON object representing match data, including fields like count, coverage metrics, match ratio, and creation timestamps. This serves as an example of the data format returned or expected.

```json
{
  "count": 123,
  "coverageSearchMin": 123.45,
  "coverageSearchMax": 987.65,
  "coverageSearchSum": 987.65,
  "coverageSearchAvg": 987.65,
  "coverageMatchMin": 123.45,
  "coverageMatchMax": 123.45,
  "coverageMatchSum": 123.45,
  "coverageMatchAvg": 987.65,
  "matchRatioMin": 987.65,
  "matchRatioMax": 123.45,
  "matchRatioSum": 123.45,
  "matchRatioAvg": 123.45,
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### SearchSetPatch Object Example

Source: https://docs.ecoroute.io/index

Provides an example of the SearchSetPatch object, used for updating existing search sets. It includes fields for searches, tags, locations, merge set references, active status, creation timestamp, state, and dispatch date time.

```json
{
  "searches": [SearchRef],
  "tags": [TagRef],
  "start": "abc123",
  "destination": "abc123",
  "baseMergeSet": MergeSetRef,
  "mergeMergeSet": MergeSetRef,
  "mergeSet": MergeSetRef,
  "active": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "state": "NEW",
  "dispatchDateTime": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### UpdateDispatchDateTimeFilterPayload Example

Source: https://docs.ecoroute.io/index

An example JSON object for 'UpdateDispatchDateTimeFilterPayload'. This payload contains the updated 'DispatchDateTimeFilter' objects and the number of unique IDs affected by the update.

```json
{
  "dispatchDateTimeFilter": [DispatchDateTimeFilter],
  "numUids": 123
}
```

--------------------------------

### DispatchDateTimeRangeOrder Example

Source: https://docs.ecoroute.io/index

Demonstrates the structure for ordering dispatch date-time ranges, supporting ascending, descending, and chained ordering.

```json
{
  "asc": "min",
  "desc": "min",
  "then": "DispatchDateTimeRangeOrder"
}
```

--------------------------------

### Int Scalar Type Example

Source: https://docs.ecoroute.io/index

Provides an example of the Int scalar type, representing signed whole numbers within a specific range.

```json
987
```

--------------------------------

### DateTime Filtering Example

Source: https://docs.ecoroute.io/index

Example demonstrating various ways to filter by date and time using operators like equals (eq), less than or equal to (le), less than (lt), greater than or equal to (ge), greater than (gt), in a list (in), and within a range (between).

```json
{
  "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
}
```

--------------------------------

### AddTagInput Example

Source: https://docs.ecoroute.io/index

Example of the AddTagInput object, used for creating a new tag. It includes the tag's name, associated users, search sets, merge sets, match sets, searches, and creation timestamp.

```json
{
  "name": "xyz789",
  "users": [UserRef],
  "searchSets": [SearchSetRef],
  "mergeSets": [MergeSetRef],
  "matchSets": [MatchSetRef],
  "searches": [SearchRef],
  "createdAt": "2007-12-03T10:15:30Z"
}
```

--------------------------------

### GenerateMutationParams Example

Source: https://docs.ecoroute.io/index

Illustrates the parameters for generating mutations, controlling add, update, and delete operations.

```json
{"add": false, "update": true, "delete": true}
```

--------------------------------

### Waypoint Order Example

Source: https://docs.ecoroute.io/index

This example demonstrates the WaypointOrder object, used for specifying the sorting order of waypoint query results. It supports ascending ('asc') and descending ('desc') orderings, and chaining multiple order criteria with 'then'.

```json
{"asc": "id", "desc": "id", "then": WaypointOrder}
```

--------------------------------

### DispatchDateTimeFilterAggregateResult Example

Source: https://docs.ecoroute.io/index

An example of DispatchDateTimeFilterAggregateResult, showing aggregated data for dispatch time filters. It includes counts and min/max values for various filter conditions.

```json
{
  "count": 123,
  "eqMin": "2007-12-03T10:15:30Z",
  "eqMax": "2007-12-03T10:15:30Z",
  "leMin": "2007-12-03T10:15:30Z",
  "leMax": "2007-12-03T10:15:30Z",
  "ltMin": "2007-12-03T10:15:30Z",
  "ltMax": "2007-12-03T10:15:30Z",
  "geMin": "2007-12-03T10:15:30Z",
  "geMax": "2007-12-03T10:15:30Z",
  "gtMin": "2007-12-03T10:15:30Z",
  "gtMax": "2007-12-03T10:15:30Z"
}
```
Tokens:
Raw