Skip to content
digizeDocs

Get Ads settings

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

Conversion tracking, attribution, click protection, budget alerts and approval.

Needs the ads:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
conversionApis
required
Array<object>
object
platform
required
string
Allowed values: google meta tiktok linkedin microsoft pinterest
name
required
string
enabled
required
boolean
events
required
number
lastEventAt
required
Any of:
string format: date-time
matchQuality
required
string | null
attributionWindow
required
string
Allowed values: 1d_click 7d_click 7d_click_1d_view 28d_click
utmTemplate
required
string
protection
required
object
mode
required
string
Allowed values: off monitor block
repeatClicks
required
integer
>= 2 <= 50
windowHours
required
integer
>= 1 <= 168
blockDays
required
integer
>= 1 <= 90
blockNetworks
required
boolean
blockAutomation
required
boolean
allowedCountries
required
Array<string>
<= 50 items
response
required
string
Allowed values: page not_found server_error
shield
required

Scripted traffic on every page: strict turns away all of it, safe only what comes from VPNs and data centers.

string
Allowed values: off safe strict
syncGoogleAds
required

Adds blocked addresses to Google Ads campaigns as IP exclusions.

boolean
alerts
required
object
enabled
required
boolean
monthlyCap
required
Any of:

In the workspace currency’s minor unit: 3000 is $30.00.

integer
<= 100000000
threshold
required
integer
>= 10 <= 100
overspend
required
boolean
rejections
required
boolean
recipients
required
Array<string>
<= 50 items
approval
required
object
required
required
boolean
above
required
Any of:

In the workspace currency’s minor unit: 3000 is $30.00.

integer
<= 100000000
approvers
required
Array<string>
<= 50 items
shortLinkDomain
required

The workspace’s own short link domain; null for the platform’s.

string | null

Example 

{
  "conversionApis": [
    {
      "platform": "google"
    }
  ],
  "attributionWindow": "1d_click",
  "protection": {
    "mode": "off",
    "response": "page",
    "shield": "off"
  }
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
  }
}