- Table of Contents
- Enumerated Values
This is the documentation for the GreenArrow Studio API. If you have additional questions about the API, or feel that you’ve encountered a bug, please don’t hesitate to contact us at our support address.
Interactions with this API are accomplished over HTTP. On POST and PUT requests, JSON is expected as the body of the request. All API calls reply with JSON.
The JSON included as examples in this document has been nicely formatted for viewing. Neither the JSON expected as input into the API nor the JSON returned by it will be formatted this way.
All API requests will return a JSON hash with the following keys:
The API call was successful or not.
array or hash
The object returned by the particular API call, as defined in each section of this document. This will be null if the call failed.
A simple error code to identify what went wrong. This will be null if the call was successful.
A more descriptive message of what went wrong. This will be null if the call was successful.
Here’s an example of an error message returned by this API.
"error_message": "name cannot be blank",
Here are all of the error codes that Studio can return. See the error_message value for more information on the specific response.
The client tried to create or update a record into an invalid state.
The request could not be processed.
The client requested too many records at once.
The requested record could not be found.
The request found multiple records instead of one.
The request caused an error within GreenArrow Studio.
Dates and Times
Times are passed to the API in ISO 8601 date/time format:
A date (with no time) can be passed to the API, and is returned, in the following format:
Times are returned by the API as both an integer number of seconds since the UNIX epoch, and in ISO 8601 date/time format.
All fields that are interpreted as a time also have a corresponding
_epochfield with the integer number of seconds since the UNIX epoch. For example, on a subscriber the
created_atfield might have the value
2013-03-27T10:41:15-05:00, there will also be a field
created_at_epochwhich contains the integer value
The timezone of all times is the organization timezone.
During evolving the programmatic interface of API calls may change. To keep things backward compatible, Studio uses API versioning. Each request you send should explicitly specify the version of API you are targeting. There are two ways to achieve that:
You can specify version within request headers using the
You can specify version within request path using the path component
Important: for compatibility reasons you will be routed to version 1 if no version was specified!
Every request to the GreenArrow Studio API must be authenticated. This is
done via the
Authorization HTTP header in the request, as described below.
Organization administrators may create API keys from their organization’s page.
To find that page, hover over
Admin in the top navigation menu, then select
My Organization. See the
API Keys section on that screen. The
contains the value needed for authentication. The key will initially be
obscured behind a link; clicking
reveal will display the key.
Authorization header must be included in every call to the GreenArrow Studio API.
Authorization: Basic <Data>
<Data> portion of this header should be the
Key value as shown after
reveal on the Organization page.
Thus, for that example, our header would be the following.
Authorization: Basic MTowYTc0ZWQxM2ZjMTEyYTUwZTZkZjY3NDc5MDcyZjdiZDJiNDg1YzI1
Automatic Winner Selection Metrics
The number of unique opens
The number of unique clicks
The total number of opens, unique and non-unique
The total number of clicks, unique and non-unique
The ratio of unique clicks to unique opens
The subscriber is active for receiving email
The subscriber has unsubscribed from this mailing list
GreenArrow Studio has received a spam complaint for this subscriber
GreenArrow Studio received a bounce event for this subscriber
This subscriber was deactivated by a user of GreenArrow Studio
Custom Field Types
A single line text field
A multiline text field
An integer value
A specific day with month, day, and year
A month and day pairing, no year
A dropdown list of options, one option can be selected at a time
Radio boxes of options, one option can be selected at a time
A list of options as checkboxes, multiple options can be selected at a time
A value that can be