Skip to content

Campaignsリストをエクスポートする

get

/campaigns/list

このエンドポイントを使用して、Campaignsのリストをエクスポートします。各Campaignには、名前、Campaign API識別子、APIキャンペーンであるかどうか、およびCampaignに関連付けられたタグが含まれます。

Campaignsは、作成時間順（デフォルトでは古いものから新しいもの）にソートされた100件のグループで返されます。

See me in Postman

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエストパラメーター

リクエスト例

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/campaigns/list?page=0&include_archived=false&sort_direction=desc&last_edit.time[gt]=2020-06-28T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

1
2
3
4
5
6
7
8
9
10
11
12
13

{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "campaigns" : [
        {
            "id" : (string) the Campaign API identifier,
            "last_edited": (ISO 8601 string) the last edited time for the message
            "name" : (string) the campaign name,
            "is_api_campaign" : (boolean) whether the campaign is an API campaign,
            "tags" : (array) the tag names associated with the campaign formatted as strings
        },
        ...
    ]
}
New Stuff!