ऑडियंस
इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।
ऑपरेशन
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अधिकतम 1576800grainstringHow 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