uloggdDesenvolvedores
Portal do desenvolvedoruloggd
ComeçarRecursosArcade
Portal do desenvolvedoruloggdIdentidadeCatálogoPerfilBibliotecaAvaliaçõesDiárioListasPremiaçõesCapturasSocialContaNotificaçõesComentáriosCurtidasHistóricoPessoasMineraisArcade

Diário

Sessões, e as jornadas que as agrupam.

Uma jornada é uma passagem por um jogo. Uma sessão pode marcar o começo ou o fim de uma.

GET/api/v1/journal/entries

Sessões registradas, as jogadas mais recentes primeiro.

Escopo journal.read · Conta na cota read

Parâmetros

CampoTipoObservações
gameintegerFiltra por id de jogo.
limitinteger1 a 1000, padrão 50.
POST/api/v1/journal/entries

Registra uma sessão. Responde 201.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
igdb_idobrigatóriointegerO id do jogo no catálogo.
game_slugobrigatóriostringO slug do jogo.
played_ondateAAAA-MM-DD. Padrão: hoje.
ended_ondatePara uma sessão que atravessa dias.
minutesintegerDe 0 a 100000.
notestringMarkdown, até 5000 caracteres.
visibilitystringPUBLIC, FOLLOWERS ou PRIVATE.
marks_startbooleanEsta sessão começou o jogo.
marks_finishbooleanEsta sessão terminou o jogo.
started_atstringA hora em que a sessão começou, HH:MM ou HH:MM:SS. Opcional: um dia inteiro também é uma sessão.
journey_idstringA jornada a que esta sessão pertence. Tem de ser uma jornada sua e do mesmo jogo; sem ela a sessão fica solta.
comments_scopestringQuem pode responder: EVERYONE, FOLLOWERS ou NOBODY.
PATCH/api/v1/journal/entries/{id}

Altera uma sessão. Aceita os mesmos campos do POST, sem igdb_id nem game_slug, e mais dois que só fazem sentido depois que a sessão existe.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
sensitivebooleanEsconde as imagens atrás de um aviso. Desligar isso não apaga o registro de uma marca automática: é o que deixa a decisão revisável depois.
image_orderarrayOs ids das imagens da sessão, na ordem em que devem aparecer, até 12. As imagens em si entram pelo site; aqui só se ordena o que já está lá.
DELETE/api/v1/journal/entries/{id}

Remove uma sessão.

Escopo journal.write · Conta na cota write

PUT/api/v1/journal/days

Marca vários dias de uma vez como jogados, sem descrever nenhum deles. É o traço no calendário: um dia já coberto por uma sessão é deixado como está, e added conta o que mudou, não o que foi pedido.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
igdb_idobrigatóriointegerO id do jogo no catálogo.
game_slugobrigatóriostringO slug do jogo.
daysobrigatórioarrayDe 1 a 366 datas como YYYY-MM-DD. Nenhuma pode estar no futuro.
journey_idstringA jornada a que os dias pertencem. Sem ela, ficam soltos.

Exemplo

{
  "data": { "igdb_id": 14593, "days": ["2026-09-01", "2026-09-02"], "added": 1 }
}
DELETE/api/v1/journal/days

Apaga as sessões que cobrem esses dias. Vai por parâmetro e não por corpo, porque um DELETE com corpo não atravessa toda intermediária.

Escopo journal.write · Conta na cota write

Parâmetros

CampoTipoObservações
igdb_idobrigatóriointegerO id do jogo no catálogo.
daysobrigatóriostringAs datas separadas por vírgula, de 1 a 366.
journey_idstringLimita a remoção às sessões dessa jornada.
GET/api/v1/journal/entries/{id}

Um registro visível, autor, galeria e contexto de interação.

Escopo journal.read · Conta na cota read

GET/api/v1/journal/journeys/{id}

Metadados públicos de uma jornada e quantidade de sessões públicas.

Escopo journal.read · Conta na cota read

GET/api/v1/journal/journeys/{id}/entries

Sessões visíveis de uma jornada, 40 por página, com imagens e resumo. page: 1 a 1000.

Escopo journal.read · Conta na cota read

GET/api/v1/journal/journeys

As jornadas do dono.

Escopo journal.read · Conta na cota read

Parâmetros

CampoTipoObservações
gameintegerFiltra por id de jogo.
limitinteger1 a 1000, padrão 50.
POST/api/v1/journal/journeys

Abre uma jornada num jogo. Responde 201.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
igdb_idobrigatóriointegerO id do jogo no catálogo.
game_slugobrigatóriostringO slug do jogo.
titleobrigatóriostringAté 120 caracteres.
PATCH/api/v1/journal/journeys/{id}

Renomeia uma jornada, ou diz que tipo de jornada ela foi. Um campo de cada vez: o que não vier no corpo fica como está, e o que vier em clear fica vazio. Terminar antes de começar é recusado.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
titlestringAté 120 caracteres.
statusstringPLANNED, PLAYING, ON_HOLD, COMPLETED ou DROPPED. É o estado da jornada, não o do jogo.
started_onstringAAAA-MM-DD.
finished_onstringAAAA-MM-DD.
library_entry_idstringA cópia em que esta jornada foi jogada.
replaybooleanSe o jogo já tinha sido jogado antes desta.
masteredbooleanSe a platina ou os 100% saíram nesta jornada.
difficultystringAté 80 caracteres.
progressstringAté 160 caracteres.
cleararrayCampos a esvaziar: status, started_on, finished_on, difficulty, progress, replay, mastered ou library_entry_id. Um campo não pode vir com valor e em clear ao mesmo tempo.
DELETE/api/v1/journal/journeys/{id}

Remove uma jornada.

Escopo journal.write · Conta na cota write

GET/api/v1/journal/sessions

A sessão aberta do dono, com o jogo e os eventos dela. Responde data: null quando não há nenhuma.

Escopo journal.read · Conta na cota read

POST/api/v1/journal/sessions

Abre uma sessão. Uma por conta: responde 409 quando já existe outra aberta. Responde 201.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
igdb_idobrigatóriointegerO id do jogo no catálogo.
game_slugobrigatóriostringO slug do jogo.
journey_idstringLiga a sessão a uma jornada sua.
visibilitystringPUBLIC, FOLLOWERS ou PRIVATE.
POST/api/v1/journal/sessions/{id}/events

Anota algo que aconteceu na sessão aberta. Só acrescenta: um evento não se edita. Responde 201.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
kindobrigatóriostringNOTE, PROGRESS, SHOT ou STOP. NOTE e STOP pedem body, PROGRESS pede marker, SHOT pede screenshot_id.
bodystringAté 500 caracteres.
markerstringAté 80 caracteres.
screenshot_idstringUma captura sua.
PATCH/api/v1/journal/sessions/{id}

Encerra a sessão, que é o que a transforma em registro. Sem minutos, vale o tempo corrido, limitado a 16 horas.

Escopo journal.write · Conta na cota write

Corpo

CampoTipoObservações
minutesintegerDe 0 a 100000. O relógio conta, você confirma.
notestringAté 5000 caracteres.
marks_finishbooleanMarca que o jogo terminou nesta sessão.
DELETE/api/v1/journal/sessions/{id}

Descarta uma sessão aberta que não registrou nada. Responde 409 quando já tem eventos: aí o caminho é encerrar.

Escopo journal.write · Conta na cota write

Avaliações

As avaliações do dono.

Listas

Coleções e rankings, e os jogos dentro deles.