Skip to content
digizeDocs

List short links

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

Short links, the newest first, with their clicks and attributed orders over the last 30 days, and the domain new ones go on.

Needs the ads:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
domain
required
string
links
required
Array<object>
object
id
required
string
domain
required
string
slug
required
string
destination
required
string
utm
required
Any of:
object
source
required
string
<= 100 characters
medium
required
string
<= 100 characters
campaign
required
string
<= 100 characters
clicks
required

Last 30 days.

number
orders
required
number
revenue
required
number
days
required
Array<object>
object
date
required
string format: date-time
clicks
required
number
referrers
required
Array<object>
object
label
required
string
value
required
number
createdAt
required
string format: date-time
lastClickAt
required
Any of:
string format: date-time

Example generated

{
  "domain": "example",
  "links": [
    {
      "id": "example",
      "domain": "example",
      "slug": "example",
      "destination": "example",
      "utm": {
        "source": "example",
        "medium": "example",
        "campaign": "example"
      },
      "clicks": 1,
      "orders": 1,
      "revenue": 1,
      "days": [
        {
          "date": "2026-04-15T12:00:00Z",
          "clicks": 1
        }
      ],
      "referrers": [
        {
          "label": "example",
          "value": 1
        }
      ],
      "createdAt": "2026-04-15T12:00:00Z",
      "lastClickAt": "2026-04-15T12:00:00Z"
    }
  ]
}

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"
  }
}