Difference between revisions of "API Info"

Revision as of 14:29, 8 June 2015

Create, Read, Update, and Delete functionality is available for the following entities:

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)

@@ Line 1: / Line 1: @@
-Service Endpoint
+== Service Endpoint<br/> ==
-{| class="prettytable"
-|-
-|
-'''Base URL'''
-|
+== <br/>Entities<br/> ==
-[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: