List Apple business account events

GET

/v1/amb/business-accounts/{business_account_id}/events

const result = await bird.amb.businessAccounts.events.list(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
  { limit: 20 },
);
console.log(result);

result = client.amb.business_accounts.events.list('abz_01krdgeqcxet5s7t44vh8rt9mg', limit=20)
print(result)

for item, err := range client.Amb.BusinessAccounts.Events.List(context.Background(), "abz_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbBusinessAccountsEventsListParams{Limit: 20}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(item)
}

foreach ($bird->amb->businessAccounts->events->list('abz_01krdgeqcxet5s7t44vh8rt9mg', ['limit' => '20']) as $item) {
    var_dump($item);
}

bird amb business-accounts events list <business-account-id>

curl -X GET "https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}/events" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Antwort200

{
  "data": [
    {
      "id": "abe_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "amb_business_account.created"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns account activity with event time, summary and source metadata, newest first by default.

Parameter

business_account_id

string

Abfrageparameter

sort

string

Field to sort by. Possible values: created_at. Defaults to created_at.

Possible values: created_at

order

string

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

Possible values: asc, desc

limit

integer

Maximum number of items to return per page.

starting_after

string

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_before

string

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

include_total

boolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

Antwort-Payload

data

array of object

erforderlich

Untergeordnete Attribute anzeigen

data.id

string

erforderlich

data.type

string

erforderlich

Possible values (may grow over time): amb_business_account.created, amb_business_account.status_changed, amb_business_account.submission_created, amb_business_account.review_changed, amb_business_account.invitation_access_changed, amb_business_account.suspension_changed

data.summary

string

erforderlich

data.metadata

object

erforderlich

Details of the change. source identifies whether a customer or Bird staff recorded it.

data.created_at

string

erforderlich

next_cursor

nullable string

erforderlich

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

erforderlich

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

erforderlich

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total

nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Should I use a Bird SDK or call the API directly?Das Konzept verstehen

Build your first integrationDem Lernpfad folgen

Send your first emailImplementierungsleitfaden

Implementierungs-Briefing erhalten

const result = await bird.amb.businessAccounts.events.list(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
  { limit: 20 },
);
console.log(result);

result = client.amb.business_accounts.events.list('abz_01krdgeqcxet5s7t44vh8rt9mg', limit=20)
print(result)

for item, err := range client.Amb.BusinessAccounts.Events.List(context.Background(), "abz_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbBusinessAccountsEventsListParams{Limit: 20}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(item)
}

foreach ($bird->amb->businessAccounts->events->list('abz_01krdgeqcxet5s7t44vh8rt9mg', ['limit' => '20']) as $item) {
    var_dump($item);
}

bird amb business-accounts events list <business-account-id>

curl -X GET "https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}/events" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Antwort200

{
  "data": [
    {
      "id": "abe_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "amb_business_account.created"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}