Listening

Generated listening operations.

GET/v1/listening/preferencesRead listening preferencesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_listening_preferences

Responses

200Successapplication/json

Example

{
  "data": {
    "bookRate": 0,
    "passoutMinutes": 0,
    "revision": 0
  },
  "scope": {
    "accountId": "id_8h2k4q",
    "authority": "string",
    "profileId": "id_8h2k4q",
    "serverId": "id_8h2k4q"
  }
}

Schema

dataobjectrequired
- bookRatenumberrequired
- passoutMinutesintegerrequired
- revisionintegerrequired
scopeobjectrequired
- accountIdstringrequired
- authoritystringrequired
- profileIdstringrequired
- serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/listening/preferences" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/listening/preferencesSave listening preferencesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: put_listening_preferences
Max body: 64 KiB

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "bookRate": 0,
  "passoutMinutes": 0,
  "revision": 0
}

Schema

bookRatenumber | any | nullrequired
passoutMinutesinteger | any | nullrequired
revisioninteger | any | nullrequired

Responses

200Successapplication/json

Example

{
  "data": {
    "bookRate": 0,
    "passoutMinutes": 0,
    "revision": 0
  },
  "scope": {
    "accountId": "id_8h2k4q",
    "authority": "string",
    "profileId": "id_8h2k4q",
    "serverId": "id_8h2k4q"
  }
}

Schema

dataobjectrequired
- bookRatenumberrequired
- passoutMinutesintegerrequired
- revisionintegerrequired
scopeobjectrequired
- accountIdstringrequired
- authoritystringrequired
- profileIdstringrequired
- serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/listening/preferences" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bookRate":0,"passoutMinutes":0,"revision":0}'