Skip to content
ReputeCastReputeCast Docs

Earn › Sponsors: income, a slot's issues with their bookings, the library and what needs a person

GET
/api/v1/workspaces/{workspace}/sponsors/overview
curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sponsors/overview?range=around' \
  --header 'Authorization: Bearer <token>'

Permission: earn:view

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

Query Parameters

Section titled “Query Parameters”
slot

A slot’s id; the first slot when absent.

string

A slot’s id; the first slot when absent.

range
string
default: around
Allowed values: around upcoming recent all

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
canManage
required
boolean
currency
required
string
helpers
required
Array<string>
library
required
Array<object>
object
bookedCents
required
integer format: int64
clickRate
number format: double
clickRateIssue
integer format: int64
contactEmail
required
string
contactName
required
string
currency
required
string
hold
required
Array<integer>
holdCents
required
integer format: int64
id
required
string
initials
required
string
issues
required
Array<integer>
logoUrl
required
string
name
required
string
notes
required
string
paidCents
required
integer format: int64
termsDays
required
integer format: int64
website
required
string
notices
required
Array<object>
object
amountCents
required
integer format: int64
bookingId
required
string
contactEmail
required
string
contactName
required
string
daysToIssue
required
integer format: int64
due
string format: date-time
issue
required
integer format: int64
issueOn
required
string format: date-time
kind
required
string
Allowed values: creative_late payment_overdue hold_lapsing no_campaign
listName
required
string
slotId
required
string
sponsor
required
string
past
required
Array<object>
object
booking
object
clickRate
number format: double
creativeDue
string format: date-time
creativeStatus
required
string
Allowed values: waiting ready
final
required
boolean
holdUntil
string format: date-time
id
required
string
payment
required
object
due
string format: date-time
note
required
string
paidCents
integer format: int64
paidOn
string format: date-time
recordedAt
string format: date-time
recordedBy
string
status
required
string
Allowed values: unpaid paid overdue
priceCents
required
integer format: int64
proposal
object
agent
required
string
at
required
string format: date-time
id
required
string
note
required
string
priceCents
required
integer format: int64
sponsor
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
resultsFinalAt
string format: date-time
sentAt
string format: date-time
sharedAt
string format: date-time
sponsor
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
status
required
string
Allowed values: hold booked sent
campaign
object
at
string format: date-time
author
string
byHand
required
boolean
id
required
string
name
required
string
status
required
string
issueOn
required
string format: date-time
number
required
integer format: int64
past
required
boolean
proposal
object
agent
required
string
at
required
string format: date-time
id
required
string
note
required
string
priceCents
required
integer format: int64
sponsor
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
slotId
required
string
slotName
required
string
range
required
string
Allowed values: around upcoming recent all
slotId
required
string
slots
required
Array<object>
object
bookings
required
integer format: int64
creativeDays
required
integer format: int64
currency
required
string
everyDays
required
integer format: int64
firstNumber
required
integer format: int64
firstOn
required
string format: date-time
id
required
string
listId
required
string
listName
required
string
name
required
string
placement
required
string
priceCents
required
integer format: int64
selling
required
boolean
weekday
string
tiles
required
object
avgClickIssues
required
Array<integer>
avgClickRate
number format: double
bookedAheadCents
required
integer format: int64
bookedAheadIssues
required
Array<integer>
holdAheadCents
required
integer format: int64
income30dCents
required
integer format: int64
incomeIssues
required
integer format: int64
nextBooked
required
integer format: int64
nextCount
required
integer format: int64
nextFrom
required
integer format: int64
nextHold
required
integer format: int64
nextOpen
required
integer format: int64
nextTo
required
integer format: int64
paid30dCents
required
integer format: int64
unpaid30dCents
required
integer format: int64
upcoming
required
Array<object>
object
booking
object
clickRate
number format: double
creativeDue
string format: date-time
creativeStatus
required
string
Allowed values: waiting ready
final
required
boolean
holdUntil
string format: date-time
id
required
string
payment
required
object
due
string format: date-time
note
required
string
paidCents
integer format: int64
paidOn
string format: date-time
recordedAt
string format: date-time
recordedBy
string
status
required
string
Allowed values: unpaid paid overdue
priceCents
required
integer format: int64
proposal
object
agent
required
string
at
required
string format: date-time
id
required
string
note
required
string
priceCents
required
integer format: int64
sponsor
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
resultsFinalAt
string format: date-time
sentAt
string format: date-time
sharedAt
string format: date-time
sponsor
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
status
required
string
Allowed values: hold booked sent
campaign
object
at
string format: date-time
author
string
byHand
required
boolean
id
required
string
name
required
string
status
required
string
issueOn
required
string format: date-time
number
required
integer format: int64
past
required
boolean
proposal
object
agent
required
string
at
required
string format: date-time
id
required
string
note
required
string
priceCents
required
integer format: int64
sponsor
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
slotId
required
string
slotName
required
string

Example 

{
  "notices": [
    {
      "kind": "creative_late"
    }
  ],
  "past": [
    {
      "booking": {
        "creativeStatus": "waiting",
        "payment": {
          "status": "unpaid"
        },
        "status": "hold"
      }
    }
  ],
  "range": "around",
  "upcoming": [
    {
      "booking": {
        "creativeStatus": "waiting",
        "payment": {
          "status": "unpaid"
        },
        "status": "hold"
      }
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0