Docs
Management API
Analytics

Analytics

Get All Web Analytics Providers

GET /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 settings. If omitted, you will interact with the global settings only.

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

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
    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 settings. If omitted, you will interact with the global settings only.

example

Response

Successful operation.

Body

object | application/json
  • code
    string

    Web Analytics Provider code.

  • enabled
    boolean

    Flag indicates if Web Analytics Provider is enabled or not.

  • id
    integer

    Web Analytics Provider ID.

  • name
    string

    Web Analytics Provider title.

example

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
    required

Parameters

  • store_hash in path - string
  • 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
  • channel_id
    number

  • code
    string

    >= 1 characters
  • data_tag_enabled
    boolean

  • enabled
    boolean

  • id
    number

  • is_oauth_connected

  • name
    string

    >= 1 characters
  • version
    number

example

Response

Successful operation.

Body

object | application/json
  • code
    string

    Web Analytics Provider code.

  • enabled
    boolean

    Flag indicates if Web Analytics Provider is enabled or not.

  • id
    integer

    Web Analytics Provider ID.

  • name
    string

    Web Analytics Provider title.

example

Did you find what you were looking for?