Skip to content

「ニュースフィードカードを書き出す」リスト

get

/feed/list

このエンドポイントを使用して、ニュースフィードカードのリストをエクスポートします。各カードには、その名前とカードAPI 識別子が含まれます。

カードは、作成日時(デフォルトでは最も古いものから最新のもの) でソートされた100 のグループで返されます。

前提条件

このエンドポイントを使用するには、feed.list 権限を持つAPI キー が必要です。

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

要求パラメータ

パラメータ 必須 データ型 説明
page オプション 整数 返されるカードのページ。デフォルトは0 です(100 までの最初のセットを返します)。
include_archived オプション ブール アーカイブされたカードを含めるかどうかに関係なく、デフォルトはfalse になります。
sort_direction オプション String - 作成時刻を最新から最も古い順に並べ替えます。値desc を渡します。
- 作成時刻を最も古いものから最新のものにソートするには、asc の値を渡します。

sort_direction が含まれていない場合、デフォルトの順序は最も古い順から最新の順になります。

リクエスト例

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/feed/list?page=1&include_archived=true&sort_direction=desc' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

レスポンス

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "cards" : [
        {
            "id" : (string) the card API identifier,
            "type" : (string) type of the card - NewsItem (classic cards), CaptionedImage, Banner
            "title" : (string) the title of the card,
            "tags" : (array) the tag names associated with the card
        },
        ...
    ]
}
「このページはどの程度役に立ちましたか?」
New Stuff!