Docs
Management API
Settings
Analytics

Analytics

Get All Web Analytics Providers

GET /settings/analytics

Request

Returns a list of web analytics providers.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings 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: {{token}}'

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example

{
"data": [
{
"id": 0,
"channel_id": 0,
"name": "string",
"code": "string",
"enabled": true,
"data_tag_enabled": true,
"version": 0,
"api_secret": "string"
}
],
"meta": {}
}

Get a Web Analytics Provider

GET /settings/analytics/{id}

Request

Returns a single web analytics provider data for a default channel.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id in path - integer
    required
    Web Analytics Provider ID.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings 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: {{token}}'

Response

Successful operation.

Body

object | application/json

  • id    integer

    Web Analytics Provider ID.

  • channel_id    integer

    Channels ID

  • name    string

    Web Analytics Provider title.

  • code    string

    Web Analytics Provider code.

  • enabled    boolean

    Flag indicates if Web Analytics Provider is enabled or not.

  • data_tag_enabled    boolean

  • version    number

  • api_secret    string

example

{
"id": 0,
"channel_id": 0,
"name": "string",
"code": "string",
"enabled": true,
"data_tag_enabled": true,
"version": 0,
"api_secret": "string"
}

Update a Web Analytics Provider

PUT /settings/analytics/{id}

Request

Updates a single web analytics provider data for a default channel.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id in path - integer
    required
    Web Analytics Provider ID.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Body

object | application/json

  • code    string

    >= 1 characters

  • data_tag_enabled    boolean

  • enabled    boolean

  • is_oauth_connected

  • name    string

    >= 1 characters

  • version    number

example

{
"code": "string",
"data_tag_enabled": true,
"enabled": true,
"is_oauth_connected": null,
"name": "string",
"version": 0
}

Response

Successful operation.

Body

object | application/json

  • id    integer

    Web Analytics Provider ID.

  • channel_id    integer

    Channels ID

  • name    string

    Web Analytics Provider title.

  • code    string

    Web Analytics Provider code.

  • enabled    boolean

    Flag indicates if Web Analytics Provider is enabled or not.

  • data_tag_enabled    boolean

  • version    number

  • api_secret    string

example

{
"id": 0,
"channel_id": 0,
"name": "string",
"code": "string",
"enabled": true,
"data_tag_enabled": true,
"version": 0,
"api_secret": "string"
}
Did you find what you were looking for?
SettingsGet All Web Analytics Providers