投稿投稿を一覧表示する

投稿

投稿を一覧表示する

トークンが届く店舗の投稿を新しい順に返します。店舗、ステータス、期間、作成者で絞り込め、ページ単位で取得できます。

GEThttps://api.sofia-post.com/api/v1/posts
GEThttps://api.sofia-post.com/api/v1/posts

投稿を一覧表示する

トークンが届く店舗の投稿を新しい順に返します。店舗、ステータス、期間、作成者で絞り込め、ページ単位で取得できます。

認可

Authorizationstring必須

個人キーまたは OAuth アクセストークン。Bearer <token> として送信します。

このタブ内にのみ保持され、api.sofia-post.com にのみ送信されます。 API キーを取得

クエリパラメーター

establishmentIdstring

この店舗の投稿のみ。

cursorstring

前のページの nextCursor。

statusstring

ライブ:少なくとも 1 つのネットワークがこの状態の投稿。投稿の status はネットワークの要約のため、failed で絞ると partial が返ることがあります。

fromstring<date-time>

ライブ:少なくとも 1 つのネットワークが、この時刻以降に公開された(公開前は予定された)投稿。

tostring<date-time>

ライブ:この時刻より前(含まない)。

createdBystring

ライブ:me はトークンが代理する人の投稿、app はこのアプリケーションが作成した投稿。省略するとすべて。

limitnumber

ページサイズ。1 から 100 まで(既定値は 20)。

GET /v1/posts は、トークンがアクセスできるすべての投稿を新しい順に一覧し、establishmentId、status、from、to、createdBy(me または app)で絞り込めます。投稿の少なくとも 1 つのネットワークがその状態であれば、status に一致します。ページネーションをご覧ください。

投稿の状態は、投稿を取得するページで説明しています。

認可

  • Authorizationstringheader必須

    個人キーまたは OAuth アクセストークン。Bearer <token> として送信します。

クエリパラメーター

  • establishmentIdstring

    この店舗の投稿のみ。

  • cursorstring

    前のページの nextCursor。

  • statusstring

    ライブ:少なくとも 1 つのネットワークがこの状態の投稿。投稿の status はネットワークの要約のため、failed で絞ると partial が返ることがあります。

    使用できる値: draftscheduledpublishingpublishedsent_to_inboxfailed

  • fromstring<date-time>

    ライブ:少なくとも 1 つのネットワークが、この時刻以降に公開された(公開前は予定された)投稿。

  • tostring<date-time>

    ライブ:この時刻より前(含まない)。

  • createdBystring

    ライブ:me はトークンが代理する人の投稿、app はこのアプリケーションが作成した投稿。省略するとすべて。

    使用できる値: meapp

  • limitnumber

    ページサイズ。1 から 100 まで(既定値は 20)。

レスポンス

投稿の 1 ページ。続きがある場合は nextCursor を含みます。

  • dataobject[]必須

    このページの投稿

    子属性を表示
    • idstring必須

      投稿の ID

    • statusstring必須

      全ネットワークを通じた状態。partial:一方で公開され、別の一方で失敗

      使用できる値: draftscheduledpublishingpublishedsent_to_inboxfailedpartial

    • establishmentIdstring必須

      投稿の店舗

    • createdAtstring<date-time>必須

      投稿が作成された日時

    • targetsobject[]必須

      ネットワークとアカウントごとに 1 件。1 つのネットワークに 2 アカウントなら 2 件

      子属性を表示
      • platformstring必須

        ターゲットのネットワーク

      • accountIdstring必須

        公開するアカウント(GET /v1/establishments/:id/accounts)

      • statestring必須

        ネットワーク上でのターゲットの状態

        使用できる値: draftscheduledpublishingpublishedsent_to_inboxfailed

      • publishedAtstring<date-time>

        ターゲットが公開された日時

      • permalinkstring

        ネットワーク上の公開済み投稿へのリンク

      • errorstring

        ネットワークが拒否した理由

    • scheduledAtstring<date-time>

      投稿の公開予定日時

  • nextCursorstring

    次のページには ?cursor= として渡します。最後のページでは含まれません

このページは役に立ちましたか?