Admin Segments

Generated admin segments operations.

GET/v1/admin/segmentsRead intro and credits detection statusadmin

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

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "catchUpComplete": true,
    "choices": [
      "string"
    ],
    "failures": [
      {
        "errorCode": "string",
        "itemId": "id_8h2k4q",
        "state": "string",
        "title": "Fargo",
        "updatedMS": 1800000
      }
    ],
    "files": {
      "complete": 0,
      "failed": 0,
      "pending": 0,
      "unsupported": 0
    },
    "lastFullPassMS": 1800000,
    "libraries": [
      {
        "choice": "string",
        "files": {
          "complete": 0,
          "failed": 0,
          "pending": 0,
          "unsupported": 0
        },
        "itemKind": "string",
        "libraryId": "id_8h2k4q",
        "mode": "string",
        "name": "Fargo"
      }
    ],
    "mode": "string",
    "modes": [
      "string"
    ],
    "showsWaiting": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- catchUpCompletebooleanrequired
- choicesarray of stringrequired
- failuresarray of objectrequired
  - errorCodestringrequired
  - itemIdstringrequired
  - statestringrequired
  - titlestringrequired
  - updatedMSintegerrequired
- filesobjectrequired
  - completeintegerrequired
  - failedintegerrequired
  - pendingintegerrequired
  - unsupportedintegerrequired
- lastFullPassMSintegerrequired
- librariesarray of objectrequired
  - choicestringrequired
  - filesobjectrequired
    completeintegerrequired
    failedintegerrequired
    pendingintegerrequired
    unsupportedintegerrequired
  - itemKindstringrequired
  - libraryIdstringrequired
  - modestringrequired
  - namestringrequired
- modestringrequired
- modesarray of stringrequired
- showsWaitingintegerrequired
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/admin/segments" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/segments/titlesList a library's shows and films for intro and credits reviewadmin

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

Parameters

Name	In	Type
`libraryId`	query	`string`
`cursor`	query	`string`
`limit`	query	`integer`1–100

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "libraryId": "id_8h2k4q",
    "nextCursor": "eyJvIjoyMH0",
    "titles": [
      {
        "files": {
          "complete": 0,
          "failed": 0,
          "pending": 0,
          "unsupported": 0
        },
        "id": "id_8h2k4q",
        "kind": "string",
        "markers": {
          "approved": 0,
          "automatic": 0,
          "dismissed": 0,
          "suggested": 0
        },
        "title": "Fargo"
      }
    ]
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- libraryIdstringrequired
- nextCursorstringrequired
- titlesarray of objectrequired
  - filesobjectrequired
    completeintegerrequired
    failedintegerrequired
    pendingintegerrequired
    unsupportedintegerrequired
  - idstringrequired
  - kindstringrequired
  - markersobjectrequired
    approvedintegerrequired
    automaticintegerrequired
    dismissedintegerrequired
    suggestedintegerrequired
  - titlestringrequired
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/admin/segments/titles" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/segments/titles/{id}Read one show's or film's detected intros and creditsadmin

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

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "id": "id_8h2k4q",
    "kind": "string",
    "libraryId": "id_8h2k4q",
    "mode": "string",
    "seasons": [
      {
        "entries": [
          {}
        ],
        "number": 0,
        "title": "Fargo"
      }
    ],
    "title": "Fargo"
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- idstringrequired
- kindstringrequired
- libraryIdstringrequired
- modestringrequired
- seasonsarray of objectrequired
  - entriesarray of objectrequired
    durationUSstringrequired
    errorCodestringrequired
    itemIdstringrequired
    mappingRevisionstringrequired
    markerRevisionintegerrequired
    markersarray of objectrequired
    approvedbooleanrequired
    automaticSafebooleanrequired
    basisstringrequired
    confidencenumberrequired
    editedbooleanrequired
    endUSstringrequired
    idstringrequired
    kindstringrequired
    provenancestringrequired
    startUSstringrequired
    viewerVisiblebooleanrequired
    numberintegerrequired
    sourceIdstringrequired
    sourceRevisionstringrequired
    statestringrequired
    titlestringrequired
  - numberintegerrequired
  - titlestringrequired
- titlestringrequired
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/admin/segments/titles/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/segments/titles/{id}/approveApprove a show's or season's detected segmentsadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: post_admin_segments_titles_id_approve
Max body: 2 MiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "kinds": [
    "string"
  ],
  "season": 0
}

Schema

kindsarray of stringrequired
seasoninteger | any | nullrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "changed": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- changedintegerrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/segments/titles/{id}/approve" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kinds":["string"],"season":0}'

POST/v1/admin/segments/titles/{id}/redetectDetect a show's or film's intros and credits againadmin

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

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "changed": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- changedintegerrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/segments/titles/{id}/redetect" \
  -H "Authorization: Bearer $PORTICO_API_KEY"