PostinganDaftar postingan

Postingan

Daftar postingan

Mendaftar postingan usaha yang dijangkau token, terbaru lebih dulu, dapat difilter menurut usaha, status, rentang tanggal, dan penulis, per halaman.

GEThttps://api.sofia-post.com/api/v1/posts
GET/v1/posts
curl -X GET 'https://api.sofia-post.com/api/v1/posts' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Otorisasi

  • Authorizationstringwajib

    Kunci pribadi atau access token OAuth Anda, dikirim sebagai Bearer <token>.

Parameter query

  • establishmentIdstring

    Hanya postingan usaha ini.

  • cursorstring

    nextCursor dari halaman sebelumnya.

  • statusstring

    Live: minimal satu jaringan dalam status ini. status postingan meringkas jaringannya, jadi memfilter failed bisa mengembalikan partial.

    Nilai yang diizinkan: draftscheduledpublishingpublishedsent_to_inboxfailed

  • fromstring<date-time>

    Live: minimal satu jaringan terpublikasi (atau, sebelum publikasi, terjadwal) sejak saat ini.

  • tostring<date-time>

    Live: dan sebelum saat ini (tidak termasuk).

  • createdBystring

    Live: me untuk postingan orang yang diwakili token, app untuk yang dibuat aplikasi ini. Tidak diisi: semuanya.

    Nilai yang diizinkan: meapp

  • limitnumber

    Ukuran halaman, dari 1 sampai 100 (default 20).

Respons

200application/json

Satu halaman postingan, dengan nextCursor bila masih ada lanjutan.

  • dataobject[]wajib

    Postingan di halaman ini

    Tampilkan atribut turunan
    • idstringwajib

      Pengenal postingan

    • statusstringwajib

      Di semua jaringan; partial: terbit di satu, gagal di yang lain

      Nilai yang diizinkan: draftscheduledpublishingpublishedsent_to_inboxfailedpartial

    • establishmentIdstringwajib

      Usaha pemilik postingan

    • createdAtstring<date-time>wajib

      Kapan postingan dibuat

    • targetsobject[]wajib

      Satu entri per jaringan dan akun: dua akun di satu jaringan, dua entri

      Tampilkan atribut turunan
      • platformstringwajib

        Jaringan target

      • accountIdstringwajib

        Akun yang memublikasikan (GET /v1/establishments/:id/accounts)

      • statestringwajib

        Status target di jaringannya

        Nilai yang diizinkan: draftscheduledpublishingpublishedsent_to_inboxfailed

      • publishedAtstring<date-time>

        Kapan target dipublikasikan

      • permalinkstring

        Tautan ke postingan yang terbit di jaringan

      • errorstring

        Alasan jaringan menolak

    • scheduledAtstring<date-time>

      Kapan postingan dijadwalkan untuk dipublikasikan

  • nextCursorstring

    Teruskan sebagai ?cursor= untuk halaman berikutnya; tidak ada di akhir

400

invalid_cursor, atau invalid_request untuk parameter yang salah format.

401

Token tidak ada, tidak dikenal, kedaluwarsa, atau dicabut.

403

Token tidak memiliki scope posts:read.

404

establishment_not_found: usaha di luar jangkauan token.

4XXapplication/json

Kesalahan lain apa pun, dalam amplop kesalahan.