オーディエンス
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
A named list of contacts in this workspace. Every contact is in the built-in default audience from the moment it exists, and builtin is what names that row; the rest are yours to make, fill and delete.
Send to one or more audiences with POST /broadcasts. A contact who unsubscribes from a broadcast stays in the audience with unsubscribedAt set, and later broadcasts to it skip them. Deleting an audience drops its memberships and leaves every contact in the book.
GET/audiences
List audiences
The built-in default audience comes first, then the rest newest first, one page at a time. contactCount on each row is counted at the moment of the read, so two reads either side of a create disagree by one.
The default audience is resolved on the first read, so a workspace that has never made an audience still lists exactly one row.
Requires the audiences:read scope.
クエリパラメーター
limitintegerRows per page, 1 to 100.
1以上100以下既定値25cursorstringAn audience id. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.
戻り値
A page of the audiences in this workspace.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
POST/audiences
Create an audience
Makes an empty audience. name is trimmed and names are not checked for duplicates, because an audience is addressed by its id.
builtin is never accepted from the body: exactly one row per workspace carries it and the server owns that row.
Requires the audiences:write scope.
リクエストボディ
namestring必須Display name, trimmed, 1 to 120 characters. Not unique.
1〜120文字descriptionstringWhat the audience is for. Leave it out to create the audience without one.
null も可1000文字まで
戻り値
Created.
エラー
- 422
workspace_limit_reachedwhen the workspace already holds the most audiences it may have.
どのオペレーションも返しうるエラー400401403404500エラー一覧
ほかの提供先
GET/audiences/growth
How audiences grew over a window
The numbers behind the growth chart on the Audiences page, in one request: for each audience, how many contacts it holds now, how many of those joined before the window, and when the rest joined, bucketed by grain.
An audience records the date each contact joined it and never the date one left. A series therefore counts the contacts still in the list today by the date they joined, and it never falls: a contact who joined inside the window and was later removed does not appear in it at all.
totals.contacts counts each person once. totals.memberships adds the lists up, and the default audience holds every contact, so a person counts once for every list they are in.
Requires the audiences:read scope.
クエリパラメーター
audienceIdsstringComma separated audience ids, at most 50. Leave it out to read every audience in the workspace, the default one included. A repeated id counts once.
4000文字までdaysintegerHow far back to look. The window starts at the beginning of its first bucket in the offset you asked for, so the oldest bucket is a whole one, and ends now, so the newest is partial.
1以上1095以下既定値30minutesintegerThe window in minutes, which wins over
dayswhen both are sent. Use it with anhourorminutegrain to watch an import land.1以上1576800以下grainstringHow wide one bucket is, and the shape of its key:
YYYY-MM-DDfor a day,YYYY-MM-DDTHHfor an hour,YYYY-MM-DDTHH:MMfor a minute.次のいずれか"minute""hour""day"既定値"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, so a day breaks where the reader's day does rather than at midnight UTC.
-840以上840以下既定値0
戻り値
The window and one series per audience. Buckets are sparse.
エラー
- 404
audience_not_foundonaudienceIdswhen an id names no audience in this workspace. Nothing is read.- 422
invalid_parameteronaudienceIdsfor more than 50 ids, ondays,minutesoroffsetMinutesout of range, or on an unknowngrain.
どのオペレーションも返しうるエラー400401403500エラー一覧
ほかの提供先
GET/audiences/{id}
Retrieve an audience
The same shape as the list row, with a fresh contactCount. This is the cheap way to watch a count move without pulling the contacts behind it. An audience in another workspace is a 404, never a 403.
Requires the audiences:read scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
戻り値
The audience.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
PATCH/audiences/{id}
Update an audience
A partial update. The built-in default audience can be renamed and described like any other, and renaming it changes neither builtin nor what it holds. Membership is untouched here.
Requires the audiences:write scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
リクエストボディ
namestringNew display name, trimmed, 1 to 120 characters.
1〜120文字descriptionstringNew description. Null clears it.
null も可1000文字まで
戻り値
Saved.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
DELETE/audiences/{id}
Delete an audience
Deletes the audience and its memberships. The contacts themselves stay in the book, in the default audience, and in any other audience they were in.
Requires the audiences:write scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.
戻り値
Deleted.
エラー
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
audience_immutable: the built-in default audience cannot be deleted.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
GET/audiences/{id}/contacts
List an audience's contacts
The contacts themselves rather than membership records, one page at a time, each with addedAt, the date it joined this audience. Every contact in the audience is reachable by following nextCursor, which makes this the way to export an audience. Reading the built-in default audience here returns the whole address book.
audiences:read is the only scope checked, so a key with it reads the addresses in an audience without holding contacts:read.
Requires the audiences:read scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
クエリパラメーター
limitintegerRows per page, 1 to 200.
1以上200以下既定値50cursorstringThe previous page's
nextCursor, never built by hand. Send the sameq,sourceandsortwith it. Keyset, not offset: pass the previous page'snextCursor. One that names nothing in this list is a 400invalid_cursor.qstringNarrows the page to contacts whose name or address matches. When nothing in the audience matches exactly, the search allows for a typo instead, and later pages of the same query keep to the same kind of match.
200文字までsourcestringNarrows the page to contacts recorded that way.
次のいずれか"manual""auto""form"sortstringlast-heard-newestputs the contacts most recently written to first and those never written to last, the order ofGET /contacts.last-heard-oldestreverses it.added-newestandadded-oldestorder byaddedAt, the date each contact joined this audience.nameis alphabetical without case, and a contact with no name sorts by its address.次のいずれか"last-heard-newest""last-heard-oldest""added-newest""added-oldest""name"既定値"last-heard-newest"statusstring[]Comma-separated.
subscribedkeeps the members who have not unsubscribed,unsubscribedkeeps the ones who have. Leave it out, or name both, for everyone in the audience.次のいずれか"subscribed""unsubscribed"
戻り値
A page of the contacts in this audience.
エラー
- 400
invalid_cursorwhencursornames no contact in this audience.- 404
audience_not_foundwhen the id names no audience in this workspace.- 422
invalid_parameteron an unknownsort,sourceorstatus, alimitout of range or aqover 200 characters.
どのオペレーションも返しうるエラー401403500エラー一覧
ほかの提供先
POST/audiences/{id}/contacts
Add a contact to an audience
Takes an address already in the workspace book. Adding one that is already in the audience changes nothing, answers 200 and carries the original addedAt, so a retry is safe.
An address that is not a contact is refused rather than created on the spot. Save it with POST /contacts first. To add many contacts in one call, use POST /audiences/{id}/contacts/batch.
Requires the audiences:write scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
リクエストボディ
emailstring必須An address already in the workspace book. An unknown address is refused rather than created on the spot.
320文字まで形式email
戻り値
The membership, with the contact it points at.
エラー
- 422
contact_not_foundonemailwhen that address is not in the workspace book.
どのオペレーションも返しうるエラー400401403404500エラー一覧
ほかの提供先
DELETE/audiences/{id}/contacts/{email}
Remove a contact from an audience
Removes the membership. The contact stays in the book, stays in the default audience and stays in every other audience it was in. A contact that is not in this audience is a 404, so a typo cannot report a removal that never happened.
Requires the audiences:write scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.emailstring必須The contact's address, matched case insensitively.
戻り値
Removed.
エラー
- 404
audience_not_foundfor theid,contact_not_foundonemailwhen that address is not in the workspace book, oraudience_member_not_foundwhen the contact exists but is not in this audience.- 409
audience_immutable: the built-in default audience holds every contact for as long as it is a contact. Delete the contact to take it out.
どのオペレーションも返しうるエラー400401403422500エラー一覧
ほかの提供先
POST/audiences/{id}/contacts/batch
Add many contacts to an audience
Puts up to 200 existing contacts in the audience in one call, in one transaction. It never creates a contact: an address that is not in the workspace book comes back in missing and the rest are still added. To create contacts as you add them, use POST /audiences/{id}/import.
A contact already in the audience is counted in unchanged and keeps its original addedAt, so the call is safe to replay. Adding to the built-in default audience answers added: 0, because every contact is in it already.
Requires the audiences:write scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b.
リクエストボディ
emailsstring[]必須1 to 200 addresses. Each is trimmed and lower cased and a repeat counts once. They are looked up in the workspace book as they stand, so an address that is not a contact comes back in
missingrather than refusing the call.1〜200件
戻り値
What the call added, what was there already and what is not a contact.
エラー
- 404
audience_not_foundwhen the id names no audience in this workspace.- 422
invalid_parameteronemailswhen it is empty or holds more than 200 addresses, and on the entry, such asemails.2, when an address is empty or too long,unknown_parameterfor any other key in the body.
どのオペレーションも返しうるエラー400401403500エラー一覧
ほかの提供先
POST/audiences/{id}/contacts/batch-remove
Remove many contacts from an audience
Takes up to 200 contacts out of the audience in one call, in one transaction. The contacts stay in the book, in the default audience and in every other audience they are in.
Nothing is refused for one address: a contact that is not in this audience comes back in notInAudience and an address that is not a contact in missing, and the rest are still removed. A replay therefore succeeds and reports the contacts the first call removed under notInAudience.
Requires the audiences:write scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.
リクエストボディ
emailsstring[]必須1 to 200 addresses. Each is trimmed and lower cased and a repeat counts once. They are looked up in the workspace book as they stand, so an address that is not a contact comes back in
missingrather than refusing the call.1〜200件
戻り値
What the call removed, what was not in the audience and what is not a contact.
エラー
- 404
audience_not_foundwhen the id names no audience in this workspace.- 409
audience_immutable: the built-in default audience holds every contact for as long as it is a contact. Delete the contacts to take them out.- 422
invalid_parameteronemailswhen it is empty or holds more than 200 addresses, and on the entry, such asemails.2, when an address is empty or too long,unknown_parameterfor any other key in the body.
どのオペレーションも返しうるエラー400401403500エラー一覧
ほかの提供先
POST/audiences/{id}/import
Import contacts into an audience
What the CSV import on an audience page does, without the file: up to 500 rows of an address and an optional name, in one transaction. An address that is not a contact yet is saved as one, with source set to manual, and joins the default audience too. An address that is a contact already is reused as it stands and keeps its name: a name sent here only fills one that is empty. Every imported contact ends up in this audience.
A row whose address is not well formed is skipped and returned in invalid, and the other rows are still imported. Importing an address whose contact was deleted brings it back. Replaying the same rows creates nothing twice, so the call is safe to retry. Send a longer list in several calls.
Requires the audiences:write and contacts:write scopes.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. The default audience is accepted and saves the contacts without putting them in any other list.
リクエストボディ
contactsobject[]必須1 to 500 rows. Send a longer list in several calls. Rows with the same address, compared without case, count as one.
1〜500件emailstring必須Trimmed and lower cased. A row whose address is not well formed is skipped and listed in
invalid, and the other rows are still imported.1〜320文字namestringTrimmed. Used for a new contact, or for an existing one whose name is empty. A name already saved is kept.
null も可200文字まで
戻り値
What the import created, added and skipped.
エラー
- 403
insufficient_scopeunless the key holds bothaudiences:writeandcontacts:write.- 404
audience_not_foundwhen the id names no audience in this workspace.- 422
invalid_parameteroncontactswhen it is empty or holds more than 500 rows, or on a row whoseemailis empty or longer than 320 characters or whosenameis longer than 200,unknown_parameterfor any other key.
どのオペレーションも返しうるエラー400401500エラー一覧
ほかの提供先
POST/audiences/{id}/empty
Empty an audience
Takes every contact out of the audience in one transaction and answers with the audience as it now stands, contactCount 0, plus removed, the number of contacts taken out. The audience itself stays, with its name and id, and so does every contact: each one stays in the book, in the default audience and in its other audiences. No body.
There is no undo, so check the audience id before you call this.
Requires the audiences:write scope.
パスパラメーター
idstring必須Audience id such as
aud_9f2c4b7e1a0d63d84c5f2e7b. Not the default audience.
戻り値
The audience, now empty.
objectstring- 次のいずれか
"audience" idstringThe durable handle,
aud_plus 24 hex.namestringdescriptionstring- null も可
builtinstringWhich built-in audience this row is:
defaultfor the one every contact joins, null for one somebody created. Branch on this rather than on the name, which anybody can change.null も可次のいずれか"default"contactCountintegerCounted at the moment of the read, never cached.
lastContactAtstringWhen the contact who joined most recently joined this audience, read at the moment of the request. Null while the audience is empty.
null も可形式date-timecreatedAtstring- 形式
date-time updatedAtstring- 形式
date-time removedintegerContacts taken out of the audience. 0 when it was empty already.
エラー
- 404
audience_not_foundwhen the id names no audience in this workspace.- 409
audience_immutable: the built-in default audience holds every contact for as long as it is a contact, so it cannot be emptied.
どのオペレーションも返しうるエラー400401403422500エラー一覧
ほかの提供先
オブジェクト
Audienceobject
objectstring- 次のいずれか
"audience" idstringThe durable handle,
aud_plus 24 hex.namestringdescriptionstring- null も可
builtinstringWhich built-in audience this row is:
defaultfor the one every contact joins, null for one somebody created. Branch on this rather than on the name, which anybody can change.null も可次のいずれか"default"contactCountintegerCounted at the moment of the read, never cached.
lastContactAtstringWhen the contact who joined most recently joined this audience, read at the moment of the request. Null while the audience is empty.
null も可形式date-timecreatedAtstring- 形式
date-time updatedAtstring- 形式
date-time
AudienceBatchAddobject
objectstring- 次のいずれか
"audience_batch" audienceIdstringaddedintegerContacts that joined the audience in this call.
unchangedintegerContacts that were in the audience already. Their
addedAtis kept.missingstring[]The addresses that are not contacts in this workspace, trimmed, lower cased and listed once each. Nothing is created for them. Save them with
POST /contacts, or usePOST /audiences/{id}/import, which creates contacts as it goes.
AudienceBatchRemoveobject
objectstring- 次のいずれか
"audience_batch" audienceIdstringremovedintegerContacts taken out of the audience in this call.
notInAudiencestring[]Addresses of contacts that exist but were not in this audience, so there was nothing to remove for them.
missingstring[]The addresses that are not contacts in this workspace, trimmed, lower cased and listed once each. Nothing is created for them. Save them with
POST /contacts, or usePOST /audiences/{id}/import, which creates contacts as it goes.
AudienceContactobject
objectstring- 次のいずれか
"contact" emailstringTrimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed.
namestring- null も可
sourcestringautowhen a send from the app composer recorded the address,manualwhen somebody saved it here or in the app. A recorded send never downgrades amanualcontact toauto.次のいずれか"manual""auto""form"notesstring- null も可
photoUrlstringWhere the contact photo is served, or null when the contact has none. Set it with
PUT /contacts/{email}/photo. A new upload gets a new URL.null も可lastSeenAtstringWhen mail last went to this address from the app composer. Null until it does.
null も可形式date-timecreatedAtstring- 形式
date-time updatedAtstring- 形式
date-time addedAtstringWhen the contact joined this audience. The
added-newestandadded-oldestsorts order by it, and a repeated add keeps the original date.形式date-timeunsubscribedAtstringWhen the contact followed the unsubscribe link in a broadcast sent to this audience, or null while it is subscribed. An unsubscribed contact stays in the audience and in the book, and broadcasts to this audience skip it. Removing it from the audience and adding it back makes a fresh, subscribed membership. Mail sent to it one message at a time is not affected.
null も可形式date-time
AudienceContactListobject
objectstring- 次のいずれか
"list" hasMorebooleannextCursorstring- null も可
audienceIdstring
AudienceGrowthobject
objectstring- 次のいずれか
"audience_growth" sincestringThe start of the window, floored to the start of its first bucket in the local time of
offsetMinutes.形式date-timeuntilstringThe end of the window, which is the moment of the read.
形式date-timegrainstring- 次のいずれか
"minute""hour""day" offsetMinutesintegerThe offset the buckets were cut in, as sent or 0.
totalsobjectcontactsintegerDistinct contacts across the audiences read, each counted once however many of them it is in.
subscribedintegerOf those, the contacts still subscribed to at least one of the audiences read, so a broadcast to them would reach them.
membershipsintegerThe series
totalvalues added up. The default audience holds every contact, so a contact in two other audiences counts three times here.addedintegerJoins inside the window across every series.
unsubscribedintegerUnsubscribes inside the window across every series.
listsintegerHow many audiences were read.
busieststringThe bucket key with the most joins across every series, the earliest one on a tie, or null when nobody joined in the window.
null も可
seriesobject[]One per audience read, the largest first and then by name.
idstringThe audience id.
namestringbuiltinbooleanTrue for the default audience, the one that holds every contact. A boolean here, where the audience object carries the
builtinkind.totalintegerContacts in the audience now.
subscribedintegerOf those, the contacts still subscribed. The rest unsubscribed and are skipped by broadcasts.
beforeintegerOf those, the contacts that joined before
since.addedintegerOf those, the contacts that joined inside the window. With
beforeit makes uptotal.unsubscribedintegerContacts that unsubscribed from the audience inside the window.
bucketsobject[]SPARSE, oldest first. Only buckets in which somebody joined or unsubscribed are listed, so a chart has to fill the gaps with zero itself.
bucketstringThe bucket's key in the local time of
offsetMinutes:YYYY-MM-DDfor a day,YYYY-MM-DDTHHfor an hour,YYYY-MM-DDTHH:MMfor a minute.addedintegerContacts that joined the audience in that bucket and are still in it.
unsubscribedintegerContacts that unsubscribed from the audience in that bucket, through a broadcast unsubscribe link.
AudienceImportobject
objectstring- 次のいずれか
"audience_import" audienceIdstringcreatedintegerAddresses that were not contacts yet and were saved as new ones, with
sourceset tomanual.addedintegerContacts that joined this audience in this call, new and existing together. A contact already in it is not counted.
skippedintegerRows that were not imported because the address is not well formed.
invalidstring[]The addresses of the skipped rows, exactly as they were sent.
AudienceListobject
objectstring- 次のいずれか
"list" dataAudience[]hasMorebooleannextCursorstring- null も可
AudienceMemberobject
objectstring- 次のいずれか
"audience_member" audienceIdstringaddedAtstringWhen the contact first joined this audience. A repeat add answers with the original date rather than a new one.
形式date-timecontactContact
Contactobject
objectstring- 次のいずれか
"contact" emailstringTrimmed and lower cased on write. This is the key every contact route takes, because no contact id is exposed.
namestring- null も可
sourcestringautowhen a send from the app composer recorded the address,manualwhen somebody saved it here or in the app. A recorded send never downgrades amanualcontact toauto.次のいずれか"manual""auto""form"notesstring- null も可
photoUrlstringWhere the contact photo is served, or null when the contact has none. Set it with
PUT /contacts/{email}/photo. A new upload gets a new URL.null も可lastSeenAtstringWhen mail last went to this address from the app composer. Null until it does.
null も可形式date-timecreatedAtstring- 形式
date-time updatedAtstring- 形式
date-time