Analytics
Get All Web Analytics Providers
GET https://api.bigcommerce.com/stores/{store_hash}/v3/settings/analyticsRequest
Returns a list of web analytics providers.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
OK
Body
object | application/json
dataarray[object]
example
Get a Web Analytics Provider
GET https://api.bigcommerce.com/stores/{store_hash}/v3/settings/analytics/{id}Request
Returns a single web analytics provider data for a default channel.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
Web Analytics Provider ID.
example
Response
Successful operation.
Body
object | application/json
codestring
Web Analytics Provider code.
enabledboolean
Flag indicates if Web Analytics Provider is enabled or not.
idinteger
Web Analytics Provider ID.
namestring
Web Analytics Provider title.
example
Update a Web Analytics Provider
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/settings/analytics/{id}Request
Updates a single web analytics provider data for a default channel.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
Web Analytics Provider ID.
Body
object | application/json
channel_idnumber
codestring
>= 1 charactersdata_tag_enabledboolean
enabledboolean
idnumber
is_oauth_connected
namestring
>= 1 charactersversionnumber
example
Response
Successful operation.
Body
object | application/json
codestring
Web Analytics Provider code.
enabledboolean
Flag indicates if Web Analytics Provider is enabled or not.
idinteger
Web Analytics Provider ID.
namestring
Web Analytics Provider title.
example
Did you find what you were looking for?