GTM API  -  Resources

Request body 

{
  "batchImportId" : "...",
  "clientId" : "..."
}

Request body 

{
  "batchImportId" : "...",
  "clientId" : "..."
}

Set a configuration.

Example :

{
"configuration":{
"heatMapMode":false,
"nbSectorsForAutomaticSectorization":0,
"sectorColorForSingleSector":"#3399cc",
"displaySectorIds":false,
"displayMeshIds":false,
"displayCustomPointIds":false,
"displayThematicId":"them1",
"customPointsStyle":{
"strokeColor":"#FFFFFF",
"pointRadius":16,
"strokeWidth":3,
"fill":true,
"graphicName":"star",
"fillColor":"#0779BF",
"fillOpacity":66
},
"onlineGuideUrl":"https://cdn.walkme.com/users/681fb1035b334767b6e5db4ae8b68ef9/test/walkme_681fb1035b334767b6e5db4ae8b68ef9_https.js"
},
"thematics":[{
"id":"them1",
"name":"Thematic 1",
"params":"{"indicatorId":"IND_1","name":"Thematic 1","layerOpacity":100,"legendVariableSize":false,"defaultStyle":{"values":[],"graphic":{"graphicName":"CIRCLE","fillColor":"#888888","sizePercent":10}},"styles":[{"values":["Value1"],"graphic":{"graphicName":"STAR","fillColor":"#ff0000","sizePercent":100}},{"values":["Value2"],"graphic":{"graphicName":"SQUARE","fillColor":"#000000","sizePercent":100}}]}"
}]
}

Request body 

{
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  },
  "configuration" : {
    "nbSectorsForAutomaticSectorization" : 12345,
    "sectorColorForSingleSector" : "...",
    "heatMapMode" : true,
    "displaySectorIds" : true,
    "displayMeshIds" : true,
    "displayMeshCountries" : true,
    "displaySectorNames" : true,
    "displayMeshNames" : true,
    "displayCustomPointIds" : true,
    "customPointsStyle" : {
      "property1" : { },
      "property2" : { }
    },
    "skins" : [ {
      "url" : "..."
    }, {
      "url" : "..."
    } ],
    "baseLayerId" : "...",
    "defaultCountry" : "...",
    "editionMode" : true,
    "defaultSelectMode" : "...",
    "onlineGuideUrl" : "...",
    "displayResultButton" : true,
    "resultButtonLabel" : "...",
    "resultButtonTooltip" : "...",
    "resultButtonIcon" : "...",
    "displayThematicId" : "..."
  },
  "userSettings" : {
    "pointStyleCompactMode" : true,
    "measureUnit" : "...",
    "customizedSectorLabelId" : "...",
    "customizedPointLabelId" : "...",
    "includeSiteInSectorsEnvelopes" : true,
    "customizedActivityLabelId" : "...",
    "progressiveMode" : true,
    "customizedSiteLabelId" : "...",
    "automationWizard" : true,
    "lang" : "..."
  },
  "thematics" : [ {
    "id" : "...",
    "name" : "...",
    "params" : "...",
    "targetKind" : "...",
    "targetId" : "..."
  }, {
    "id" : "...",
    "name" : "...",
    "params" : "...",
    "targetKind" : "...",
    "targetId" : "..."
  } ]
}

Set a configuration.

Example :

{
"configuration":{
"heatMapMode":false,
"nbSectorsForAutomaticSectorization":0,
"sectorColorForSingleSector":"#3399cc",
"displaySectorIds":false,
"displayMeshIds":false,
"displayCustomPointIds":false,
"displayThematicId":"them1",
"customPointsStyle":{
"strokeColor":"#FFFFFF",
"pointRadius":16,
"strokeWidth":3,
"fill":true,
"graphicName":"star",
"fillColor":"#0779BF",
"fillOpacity":66
},
"onlineGuideUrl":"https://cdn.walkme.com/users/681fb1035b334767b6e5db4ae8b68ef9/test/walkme_681fb1035b334767b6e5db4ae8b68ef9_https.js"
},
"thematics":[{
"id":"them1",
"name":"Thematic 1",
"params":"{"indicatorId":"IND_1","name":"Thematic 1","layerOpacity":100,"legendVariableSize":false,"defaultStyle":{"values":[],"graphic":{"graphicName":"CIRCLE","fillColor":"#888888","sizePercent":10}},"styles":[{"values":["Value1"],"graphic":{"graphicName":"STAR","fillColor":"#ff0000","sizePercent":100}},{"values":["Value2"],"graphic":{"graphicName":"SQUARE","fillColor":"#000000","sizePercent":100}}]}"
}]
}

Request body 

{
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  },
  "configuration" : {
    "nbSectorsForAutomaticSectorization" : 12345,
    "sectorColorForSingleSector" : "...",
    "heatMapMode" : true,
    "displaySectorIds" : true,
    "displayMeshIds" : true,
    "displayMeshCountries" : true,
    "displaySectorNames" : true,
    "displayMeshNames" : true,
    "displayCustomPointIds" : true,
    "customPointsStyle" : {
      "property1" : { },
      "property2" : { }
    },
    "skins" : [ {
      "url" : "..."
    }, {
      "url" : "..."
    } ],
    "baseLayerId" : "...",
    "defaultCountry" : "...",
    "editionMode" : true,
    "defaultSelectMode" : "...",
    "onlineGuideUrl" : "...",
    "displayResultButton" : true,
    "resultButtonLabel" : "...",
    "resultButtonTooltip" : "...",
    "resultButtonIcon" : "...",
    "displayThematicId" : "...",
    "pointToPolygonAggrSettings" : {
      "baseLayerId" : "...",
      "polygonIdColumn" : "...",
      "useCoordinatesToAssign" : true,
      "visitsDurationColumn" : "...",
      "visitsFrequencyColumn" : "..."
    }
  },
  "userSettings" : {
    "pointStyleCompactMode" : true,
    "measureUnit" : "...",
    "customizedSectorLabelId" : "...",
    "customizedPointLabelId" : "...",
    "includeSiteInSectorsEnvelopes" : true,
    "customizedActivityLabelId" : "...",
    "progressiveMode" : true,
    "customizedSiteLabelId" : "...",
    "automationWizard" : true,
    "lang" : "..."
  },
  "thematics" : [ {
    "id" : "...",
    "name" : "...",
    "params" : "...",
    "targetKind" : "...",
    "targetId" : "..."
  }, {
    "id" : "...",
    "name" : "...",
    "params" : "...",
    "targetKind" : "...",
    "targetId" : "..."
  } ]
}

Request body 

{
  "rows" : [ {
    "typedValues" : [ {
      "text" : "...",
      "type" : "NUMBER",
      "value" : { }
    }, {
      "text" : "...",
      "type" : "NUMBER",
      "value" : { }
    } ],
    "emptyLine" : true,
    "values" : [ { }, { } ]
  }, {
    "typedValues" : [ {
      "text" : "...",
      "type" : "DATE",
      "value" : { }
    }, {
      "text" : "...",
      "type" : "BOOLEAN",
      "value" : { }
    } ],
    "emptyLine" : true,
    "values" : [ { }, { } ]
  } ],
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  }
}

Request body 

{
  "indicators" : [ {
    "format" : "...",
    "valueType" : "DURATION",
    "visible" : true,
    "indicator" : "..."
  }, {
    "format" : "...",
    "valueType" : "STRING",
    "visible" : true,
    "indicator" : "..."
  } ],
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  },
  "columns" : [ {
    "type" : "...",
    "id" : "...",
    "aggregateOperator" : "COUNT",
    "name" : "..."
  }, {
    "type" : "...",
    "id" : "...",
    "aggregateOperator" : "AVERAGE",
    "name" : "..."
  } ]
}

	Caution
	This operation is deprecated.

Request body 

{
  "batchImportId" : "...",
  "clientId" : "..."
}

Import items to a sectorization batch import. Example: ---- { "rows":[

Example:

{
"rows":[{"values":["70","INFOMA","Sector0","PERPIGNAN","2.217761539167103","43.053657468042346","8","4568"]},
{"values":["694","BSM","Sector0","PERPIGNAN","2.622657102449725","42.67228687522445","8","9043"]},
{"values":["743","CERN","Sector0","PERPIGNAN","1.9781492901639994","42.4177907105206","12","3328"]}
]
}

Request body 

{
  "rows" : [ {
    "typedValues" : [ {
      "text" : "...",
      "type" : "NUMBER",
      "value" : { }
    }, {
      "text" : "...",
      "type" : "NUMBER",
      "value" : { }
    } ],
    "emptyLine" : true,
    "values" : [ { }, { } ]
  }, {
    "typedValues" : [ {
      "text" : "...",
      "type" : "DATE",
      "value" : { }
    }, {
      "text" : "...",
      "type" : "BOOLEAN",
      "value" : { }
    } ],
    "emptyLine" : true,
    "values" : [ { }, { } ]
  } ],
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  }
}

Start a sectorization batch injection.

Example:

{
"columns":[{"name":"ID"},
{"name":"NAME"},
{"name":"SECTOR_CODE"},
{"name":"SECTOR_NAME"},
{"name":"LON"},
{"name":"LAT"},
{"name":"NB_CONTRATS"},
{"name":"CA"}
],
"indicators":[{"indicator":"CA","valueType":"NUMBER"},
{"indicator":"NB CONTRATS","valueType":"NUMBER"},
{"indicator":"LON","valueType":"STRING","visible":true}
]
}

Request body 

{
  "columns" : [ {
    "type" : "...",
    "id" : "...",
    "aggregateOperator" : "SUM",
    "name" : "..."
  }, {
    "type" : "...",
    "id" : "...",
    "aggregateOperator" : "NONE",
    "name" : "..."
  } ],
  "indicators" : [ {
    "format" : "...",
    "valueType" : "STRING",
    "visible" : true,
    "indicator" : "..."
  }, {
    "format" : "...",
    "valueType" : "NUMBER",
    "visible" : true,
    "indicator" : "..."
  } ]
}

Request body 

{
  "batchImportId" : "...",
  "clientId" : "..."
}

Import items to a sectorization batch import.

Request body 

{
  "rows" : [ {
    "typedValues" : [ {
      "text" : "...",
      "type" : "NUMBER",
      "value" : { }
    }, {
      "text" : "...",
      "type" : "NUMBER",
      "value" : { }
    } ],
    "emptyLine" : true,
    "values" : [ { }, { } ]
  }, {
    "typedValues" : [ {
      "text" : "...",
      "type" : "DATE",
      "value" : { }
    }, {
      "text" : "...",
      "type" : "BOOLEAN",
      "value" : { }
    } ],
    "emptyLine" : true,
    "values" : [ { }, { } ]
  } ],
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  }
}

Start a sectorization batch injection.

Request body 

{
  "columns" : [ {
    "type" : "...",
    "id" : "...",
    "aggregateOperator" : "SUM",
    "name" : "..."
  }, {
    "type" : "...",
    "id" : "...",
    "aggregateOperator" : "NONE",
    "name" : "..."
  } ],
  "indicators" : [ {
    "format" : "...",
    "valueType" : "STRING",
    "visible" : true,
    "indicator" : "..."
  }, {
    "format" : "...",
    "valueType" : "NUMBER",
    "visible" : true,
    "indicator" : "..."
  } ]
}

Import sectors to a sectorization batch import. Example:

{
"sectors":[{"sectorId":"Sector0","sectorName":"Sector #0"},
{"sectorId":"Sector1","sectorName":"Sector #1"},
{"sectorId":"Sector2","sectorName":"Sector #2"},
{"sectorId":"Sector3","sectorName":"Sector #3"},
{"sectorId":"Sector4","sectorName":"Sector #4"},
{"sectorId":"Sector5","sectorName":"Sector #5"},
{"sectorId":"Sector6","sectorName":"Sector #6"}
]
}

Request body 

{
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  },
  "sectors" : [ {
    "color" : "...",
    "sectorId" : "...",
    "sectorName" : "...",
    "sectorUpId" : "..."
  }, {
    "color" : "...",
    "sectorId" : "...",
    "sectorName" : "...",
    "sectorUpId" : "..."
  } ]
}

Import sites to a sectorization batch import.

Request body 

{
  "batchImportedSecto" : {
    "batchImportId" : "...",
    "clientId" : "..."
  },
  "sites" : [ {
    "lon" : 12345.0,
    "lat" : 12345.0,
    "sectorId" : "...",
    "sectorName" : "..."
  }, {
    "lon" : 12345.0,
    "lat" : 12345.0,
    "sectorId" : "...",
    "sectorName" : "..."
  } ]
}

Request body 

{
  "sectoId" : "..."
}

Request body 

{
  "sectoId" : "...",
  "fileName" : "...",
  "unassignedTabName" : "...",
  "image" : "...",
  "format" : "...",
  "locale" : "...",
  "localIndicators" : {
    "meshesIndicators" : [ {
      "indicators" : [ { }, { } ],
      "id" : "..."
    }, {
      "indicators" : [ { }, { } ],
      "id" : "..."
    } ],
    "indicatorLabels" : {
      "property1" : "...",
      "property2" : "..."
    },
    "sectorsIndicators" : [ {
      "indicators" : [ { }, { } ],
      "id" : "..."
    }, {
      "indicators" : [ { }, { } ],
      "id" : "..."
    } ]
  }
}

Request body 

{
  "sectoId" : "..."
}

Request body 

{
  "allSectors" : true,
  "sectorId" : "...",
  "sectoId" : "..."
}

Request body 

{
  "sectoId" : "...",
  "withGeometries" : true,
  "keepLayer" : true
}

Request body 

{
  "coord1" : 12345.0,
  "srs" : "...",
  "coord2" : 12345.0,
  "withGeometry" : true,
  "layerId" : "..."
}