getSourceSettings

GET

/settings/sources

const url = 'http://localhost:8080/api/v1/settings/sources';
const options = {method: 'GET', headers: {cookie: 'hs_session=<hs_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/settings/sources \
  --cookie hs_session=<hs_session>

Authorizations

cookieAuth
bearerAuth

Responses

200

Source settings (secrets never returned).

application/json

object

xApiKeySet

required

boolean

xMonthlyBudgetUsd

required

number

xSpentUsdThisMonth

required

number

intervals

required

object

serverS

required

integer

agentS

required

integer

retentionDays

required

object

story

required

integer

post

required

integer

mediaCacheEnabled

required

boolean

agentMaxFetchesPerPlatformPerHour

required

integer

Examples

seed

Derived from fixtures/seed.json.

{
  "agentMaxFetchesPerPlatformPerHour": 30,
  "intervals": {
    "agentS": 43200,
    "serverS": 21600
  },
  "mediaCacheEnabled": true,
  "retentionDays": {
    "post": 3650,
    "story": 7
  },
  "xApiKeySet": false,
  "xMonthlyBudgetUsd": 5,
  "xSpentUsdThisMonth": 0
}