Get All Web Analytics Providers
GET /stores/{store_hash}/v3/settings/analytics
Request
Returns a list of web analytics providers.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- channel_id in query - integer
Channel ID to use for channel-specific setting. If omitted, you will interact with the global setting only.
example
curl --request GET \ --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/settings/analytics' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'
Response
OK
Body
dataarray[object]
metaobject
Response metadata.
example
{ "data": [ { "code": "string", "enabled": true, "id": 0, "name": "string" } ], "meta": {} }
Get a Web Analytics Provider
GET /stores/{store_hash}/v3/settings/analytics/{id}
Request
Returns a single web analytics provider data for a default channel.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- id in path - integer - required
Web Analytics Provider ID.
- channel_id in query - integer
Channel ID to use for channel-specific setting. If omitted, you will interact with the global setting only.
example
curl --request GET \ --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/settings/analytics/[id]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'
Response
Successful operation.
Body
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
{ "code": "string", "enabled": true, "id": 0, "name": "string" }
Update a Web Analytics Provider
PUT /stores/{store_hash}/v3/settings/analytics/{id}
Request
Updates a single web analytics provider data for a default channel.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - string - required
The MIME type of the request body.
- id in path - integer - required
Web Analytics Provider ID.
- channel_id in query - integer
Channel ID to use for channel-specific setting. If omitted, you will interact with the global setting only.
Body
channel_idnumber
codestring
>= 1 charactersdata_tag_enabledboolean
enabledboolean
idnumber
is_oauth_connected
namestring
>= 1 charactersversionnumber
example
{ "channel_id": 0, "code": "string", "data_tag_enabled": true, "enabled": true, "id": 0, "is_oauth_connected": null, "name": "string", "version": 0 }
Response
Successful operation.
Body
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
{ "code": "string", "enabled": true, "id": 0, "name": "string" }