API Flows

API Basics/Acquiring A Session

This document explains how to get API keys and set up an admin user profile to use the Second Street API. There is also an explanation for how to acquire a session and access token as a partner admin user.

Consumer Subscription Management API

This document explains how to get an organization’s opt-in fields, see a user’s subscriptions, add/edit/delete a user’s subscriptions, search for audiences, see the members of an audience, search for users and their basic demographic data, and update basic demographic data.

Getting Consumer Profile Data API

This document explains how you can look up a ConsumerUser’s (user’s) profile to get access to demographic data, custom field responses, what audiences the person is subscribed to, and what emails the person has been sent in your organization.

Pulling Business Data and Winner Data from Ballots API

This API documentation explains how you can programmatically look up approved business nominations or write-ins from Second Street ballots and pull the entrant’s details. It also details how to look up your ballot winners.

Create & Update Ballot Ads API

This API documentation explains how you can programmatically get a list of existing ads or set ad images or ad codes (aka ad tags) for your Second Street ballot. Ads can be set for groups page, groups, categories, category interstitials, and entrants.

Creating/Sending Single Message Campaigns API

This document explains how to create message campaigns for single emails, assign message campaign audiences, add message content, and schedule the single email campaign.

Collecting and Adding User Data Via Forms API

This document explains how to create a form in Second Street with the fields you want to collect data on, how to call that form data, and how to submit a form page to Second Street. This supplies you with all the information you need to build your own form UI to collect user data on a 3rd party form and pass it to Second Street.

Messaging Analytics API

This document explains how to pull data from Second Street email dashboards. You will be able to get data from email categorical charts that show messaging statistics, message performance, a/b test performance, and message demographic data for individual message campaigns. It also explains how to get bulk data for standard email metrics for all emails at the property, market, or chain/corporate level, and how to get aggregated email data for a market or chain’s organizations.

Promotions Analytics API

This document explains how to pull data from Second Street promotion dashboards. You will be able to get data from categorical and event charts that show an individual promotion’s performance and audience makeup.

Organization Promotion Management API

This document instructs you how to look up all the promotions for a given organization, along with filter criteria for those promotions. You can also find the design contents of a given promotion which you can then use to construct your own promotion landing page.

Auditing an Organization’s Fields

This document explains how you can look up all the fields that exist in your organization and determine what types of fields they are.

Downloading Reports API

This document explains how to find IDs necessary for downloading all the reports in the Second Street platform and how to programmatically download the reports.

This document explains how you can embed Second Street’s opt out preference center on your website and bypass the initial login steps a user would typically take to identify themselves.

api-docs

Documentation for the Second Street Platform API