Config API Version 2 Installation Groups

Introduction

An Installation Group (IGRP) represents one or more web sites that are tracked (and reported) together under a single installation ID.

List IGRPs

Returns a list of IGRPs that the current user can access.

Request:

GET /config/v2/igrps

GET Params

Filter Types

Sort Types

Response:

Returns list of igrps that the current user can access.

{"orgId":"1","primaryOrgId":"1","igrp":"1","igrpName":"Test IGRP One","packageType":"enterprise-b2b"}
{"orgId":"2","primaryOrgId":"2","igrp":"2","igrpName":"Test IGRP Two","packageType":"standard-b2b"}

Deprecated Fields

Fields marked as Deprecated will be removed from the response in future iterations!

Read IGRP Config

Returns the properties for a particular IGRP.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}

URL Path Params

Response:

Returns the requested igrp details as a JSON encoded object.

{"orgId":"1","primaryOrgId":"1","igrp":"1","igrpName":"Test IGRP One","packageType":"enterprise-b2b"}

Deprecated Fields

Fields marked as Deprecated will be removed from the response in!

Update IGRP Config

Update the properties for a particular IGRP.

Note that the IGRP’s orgId (and primaryOrgId) property is read only once created. To update it you should update the orgId property of segment 0 (zero) for this IGRP.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}

URL Path Params

POST Params

Response:

Returns the HTTP response code to reflect the request outcome.

HTTP 204 - NO CONTENT

Deprecated Parameters

Parameters marked as Deprecated will stop being supported in future iterations!

Onboarding Checks

Returns a list of checks for a specific IGRP.

Request

GET /v2/igrps/{IGRP SPECIFIER}/onboardingChecks

This route accepts the following parameter:

This route supports limit, sort and filter parameters with the following filters/sorts able to be applied:

Response:

Returns a 200 OK response on success, with the following properties.

{"igrp":"1","igrpName":"Test IGRP","igrpStatus":"200","checkId":"1","checkCode":"integrationsCount","checkValue":"3","checkStatus":"200","updateDatetime":"2016-03-14 00:00:00"}