A campaign's language versions with their status and readers

GET

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

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/languages"

  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/languages';
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/languages \
  --header 'Authorization: Bearer <token>'

Permission: campaigns:view

Every workspace language is listed: the source, versions that are Up to date, Outdated (with the blocks that changed) or Draft, and Missing ones, whose readers get the fallback.

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

blocks

required

integer format: int64

canChangeSource

required

boolean

canEdit

required

boolean

canManageWorkspace

required

boolean

default

required

string

editHelpers

required

Array<string>

fallback

required

string

readers

integer format: int64

source

required

string

sourceChange

object

required

string format: date-time

blocks

required

Array<string>

required

string

outdated

required

Array<string>

version

required

integer format: int64

sourceVersion

required

integer format: int64

versions

required

Array<object>

object

attention

required

integer format: int64

blocks

required

integer format: int64

changed

required

integer format: int64

changedBlocks

required

Array<string>

changedIndexes

required

Array<integer>

gets

required

string

held

required

boolean

language

required

string

lastChange

object

required

string format: date-time

required

string

version

required

integer format: int64

name

required

string

native

required

string

noLanguage

required

integer format: int64

notOffered

required

integer format: int64

offered

required

boolean

preheader

required

string

preheaderChanged

required

boolean

readers

integer format: int64

status

required

string

Allowed values: source up_to_date outdated draft missing

still

required

integer format: int64

stillIndexes

required

Array<integer>

subject

required

string

subjectChanged

required

boolean

translated

required

integer format: int64

translatedAt

string format: date-time

translatedBy

required

string

translatedFrom

required

integer format: int64

upToDate

required

integer format: int64

updatedAt

string format: date-time

updatedBy

required

string

version

required

integer format: int64

workspaceHelpers

required

Array<string>

Example

{
  "versions": [
    {
      "status": "source"
    }
  ]
}

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