Analytics settings

GET

/api/v1/analytics/settings

const url = 'https://digize.com/api/v1/analytics/settings';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/analytics/settings \
  --header 'x-api-key: <x-api-key>'

How visits are counted (tracking, the GA4 tag, excluded addresses and paths, bot filtering), the goals with their conversions over the last 30 days, each hostname’s last visit, and how many requests the filters left out.

Needs the analytics:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

settings

required

object

tracking

required

string

Allowed values: full server off

ga4

required

A GA4 Measurement ID such as G-XXXXXXXXXX, or empty.

string

excludedIps

required

Array<string>

excludedPaths

required

Array<string>

bots

required

object

knownBots

required

boolean

automation

required

boolean

blocked

required

boolean

goals

required

Array<object>

object

required

string

name

required

string

kind

required

string

Allowed values: page event form purchase

match

required

string

value

required

number | null

createdAt

required

string format: date-time

conversions

required

Over the last 30 days.

number

sites

required

Array<object>

object

host

required

string

lastVisitAt

required

Any of:

string
null

string format: date-time

filtered

required

number

snippet

required

string

address

required

string | null

unavailable

required

Any of:

object
null

object

reason

required

string

Allowed values: token permission upstream

message

required

string

Example

{
  "settings": {
    "tracking": "full"
  },
  "goals": [
    {
      "kind": "page"
    }
  ],
  "unavailable": {
    "reason": "token"
  }
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}