Difference between revisions of "API Info"
From Enterprise Help
| Line 1: | Line 1: | ||
| − | + | Service Endpoint | |
| + | |||
| + | {| class="prettytable" | ||
| + | |- | ||
| + | | | ||
| + | '''Base URL''' | ||
| + | |||
| + | | | ||
| + | [http://services.fishbowl.com/API/odata/v1/ http://services.fishbowl.com/API/odata/v1/]<nowiki>[SiteID]/</nowiki> | ||
| + | |||
| + | |- | ||
| + | | | ||
| + | '''Endpoints''' | ||
| + | |||
| + | | | ||
| + | /Sites | ||
| + | |||
| + | /Lists | ||
| + | |||
| + | /Stores | ||
| + | |||
| + | /Members | ||
| + | |||
| + | /ProfileFields | ||
| + | |||
| + | |- | ||
| + | | | ||
| + | '''HTTP Method''' | ||
| + | |||
| + | | | ||
| + | GET to query data | ||
| + | |||
| + | |||
| + | |||
| + | For Lists and Members endpoints, these methods are also available: | ||
| + | |||
| + | POST to insert PATCH/MERGE to update DELETE to delete | ||
| + | |||
| + | |- | ||
| + | | | ||
| + | '''Header''' | ||
| + | |||
| + | | | ||
| + | Authorization: Bearer <nowiki>[ACCESS_TOKEN]</nowiki> | ||
| + | |||
| + | ''Note: Before making each request, check that the access token is still valid, otherwise obtain a new access token using the user’s refresh token.'' | ||
| + | |||
| + | |} | ||
| + | |||
| + | <br/>Entities | ||
| + | |||
| + | Create, Read, Update, and Delete functionality is available for the following entities: | ||
| + | |||
| + | *[http://enterprisehelp.fishbowl.com/Campaigns & Mailings Campaign] | ||
| + | *[http://enterprisehelp.fishbowl.com/Global Content Variables GlobalVariable] | ||
| + | *[http://enterprisehelp.fishbowl.com/Lists List] | ||
| + | *[http://enterprisehelp.fishbowl.com/Mailings Mailing] | ||
| + | *[http://enterprisehelp.fishbowl.com/Segments MailingSegment] (maps Mailings to their corresponding Segments) | ||
| + | *[http://enterprisehelp.fishbowl.com/Members Member] | ||
| + | *[http://enterprisehelp.fishbowl.com/Tags MemberTag] (maps Members to their corresponding Tags) | ||
| + | *Subscription (maps Members to the Lists to which they’re currently subscribed) | ||
| + | *[http://enterprisehelp.fishbowl.com/Tags Tag] | ||
| + | *[http://enterprisehelp.fishbowl.com/Tags TagGroup] | ||
| + | |||
| + | |||
| + | |||
| + | Read-only functionality is available for the following entities: | ||
| + | |||
| + | *ApiClientRequest (categorizes and aggregates counts of requests by API clients; useful for troubleshooting purposes) | ||
| + | *[http://en.wikipedia.org/wiki/Bounce_message Bounce] | ||
| + | *Brand | ||
| + | *Category | ||
| + | *Click (inserted when a Member clicks on any tracked hyperlink in an email message) | ||
| + | *Group | ||
| + | *GroupStore | ||
| + | *Hyperlink (automatically tracked by the Fishbowl system after being automatically discovered within the HTML or text content of a Mailing) | ||
| + | *MailOpen (inserted when a Member opens an email message and chooses to display images) | ||
| + | *Message (represents a single email message to a single Member) | ||
| + | *[http://enterprisehelp.fishbowl.com/Profile Fields ProfileField] | ||
| + | *[http://enterprisehelp.fishbowl.com/Segments Segment] | ||
| + | *Site (each Site is a fully autonomous unit with the Fishbowl system) | ||
| + | *Store | ||
| + | *SubsciptionEvent (inserted each time a Member subscribe to or unsubscribes from a single List) | ||
| + | *[http://enterprisehelp.fishbowl.com/Templates Template] | ||
| + | *[http://enterprisehelp.fishbowl.com/Themes Theme] | ||
| + | *[http://enterprisehelp.fishbowl.com/Triggered Messaging Trigger] | ||
| + | *[http://enterprisehelp.fishbowl.com/Device Statistics UserAgent] (categorizes device/application/OS data whenever a MailOpen or Click event occurs) | ||
Revision as of 14:28, 8 June 2015
Service Endpoint
|
Base URL |
|
|
Endpoints |
/Sites /Lists /Stores /Members /ProfileFields |
|
HTTP Method |
GET to query data
For Lists and Members endpoints, these methods are also available: POST to insert PATCH/MERGE to update DELETE to delete |
|
Header |
Authorization: Bearer [ACCESS_TOKEN] Note: Before making each request, check that the access token is still valid, otherwise obtain a new access token using the user’s refresh token. |
Entities
Create, Read, Update, and Delete functionality is available for the following entities:
- & Mailings Campaign
- Content Variables GlobalVariable
- List
- Mailing
- MailingSegment (maps Mailings to their corresponding Segments)
- Member
- MemberTag (maps Members to their corresponding Tags)
- Subscription (maps Members to the Lists to which they’re currently subscribed)
- Tag
- TagGroup
Read-only functionality is available for the following entities:
- ApiClientRequest (categorizes and aggregates counts of requests by API clients; useful for troubleshooting purposes)
- Bounce
- Brand
- Category
- Click (inserted when a Member clicks on any tracked hyperlink in an email message)
- Group
- GroupStore
- Hyperlink (automatically tracked by the Fishbowl system after being automatically discovered within the HTML or text content of a Mailing)
- MailOpen (inserted when a Member opens an email message and chooses to display images)
- Message (represents a single email message to a single Member)
- Fields ProfileField
- Segment
- Site (each Site is a fully autonomous unit with the Fishbowl system)
- Store
- SubsciptionEvent (inserted each time a Member subscribe to or unsubscribes from a single List)
- Template
- Theme
- Messaging Trigger
- Statistics UserAgent (categorizes device/application/OS data whenever a MailOpen or Click event occurs)
