Search Console settings

GET

/api/v1/search-console/settings

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

• Digize

Sending sitemaps after deploys, the words that make a search branded, and the emails.

Needs the analytics:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

submitOnDeploy

required

boolean

brandTerms

required

Array<string>

<= 30 items

weeklySummary

required

boolean

droppedPages

required

boolean

emails

required

Array<string>

<= 20 items

Example ^generated

{
  "submitOnDeploy": true,
  "brandTerms": [
    "example"
  ],
  "weeklySummary": true,
  "droppedPages": true,
  "emails": [
    "hello@example.com"
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/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.

Media typeapplication/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.

Media typeapplication/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).

Media typeapplication/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.

Media typeapplication/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"
  }
}