Accessibility issues of a campaign as saved

GET

/api/v1/workspaces/{workspace}/campaigns/{campaignId}/accessibility

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/accessibility"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/accessibility';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/accessibility \
  --header 'Authorization: Bearer <token>'

Permission: campaigns:view

Every language version’s compiled HTML is checked; an issue in several versions is listed once with its languages.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

campaignId

required

string format: uuid

Responses

200

application/json

object

checkedAt

required

string format: date-time

counts

required

object

dataTables

required

integer format: int64

dir

required

string

Allowed values: ltr

images

required

integer format: int64

imagesOk

required

integer format: int64

languages

required

Array<string>

layoutTables

required

integer format: int64

links

required

integer format: int64

linksOk

required

integer format: int64

overImage

required

integer format: int64

roleAdded

required

integer format: int64

durationMs

required

integer format: int64

issues

required

Array<object>

object

detail

string

element

required

object

count

required

integer format: int64

href

string

index

required

integer format: int64

label

string

role

required

string

Allowed values: image linked_image button link text heading

section

string

src

string

tag

required

string

fix

required

object

against

string

decorative

required

boolean

from

string

fromPx

number format: double

headings

required

Array<object>

object

from

required

integer format: int64

index

required

The nth heading of the text block, from 0

integer format: int64

path

required

Array<integer>

text

required

string

required

integer format: int64

kind

required

string

Allowed values: alt_text link_text color heading text_size

large

boolean

links

required

Array<object>

object

href

required

string

index

required

The nth link of the text block, from 0

integer format: int64

path

required

Array<integer>

needs

number format: double

oneClick

required

boolean

perLanguage

required

boolean

ratio

number format: double

subject

string

suggestions

required

Array<object>

object

color

required

string

ratio

required

Contrast ratio, rounded down to one decimal

number format: double

reason

required

string

Allowed values: other_buttons nearest_aa aaa

target

string

Allowed values: background text

toPx

integer format: int64

required

string

kind

required

string

Allowed values: alt_text link_no_text contrast link_text heading text_size

languages

required

Array<string>

location

required

Array<string>

name

string

path

required

Array<integer>

paths

required

Array<Array<integer>>

severity

required

string

Allowed values: serious moderate

short

required

string

tag

required

string

title

required

string

versions

required

Array<object>

object

lang

required

string

suggestion

string

text

string

languages

required

Array<object>

object

code

required

string

name

required

string

source

required

boolean

minTextPx

required

integer format: int64

mode

required

string

Allowed values: mjml html

moderate

required

integer format: int64

policy

required

string

Allowed values: warn block

serious

required

integer format: int64

Example

{
  "counts": {
    "dir": "ltr"
  },
  "issues": [
    {
      "element": {
        "role": "image"
      },
      "fix": {
        "kind": "alt_text",
        "suggestions": [
          {
            "color": "#0F766E",
            "reason": "other_buttons"
          }
        ],
        "target": "background"
      },
      "kind": "alt_text",
      "severity": "serious"
    }
  ],
  "languages": [
    {
      "code": "es",
      "name": "Spanish"
    }
  ],
  "mode": "mjml",
  "policy": "warn"
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}