What is the SumAll Partner API?
What is the SumAll Partner API?
The SumAll Partner API is a push-style API intended for SumAll partners who want to present their users’ data alongside data from other SumAll integrations (chart, email, mobile). The SumAll API exposes a small set of simple, secure HTTP endpoints for managing users and the data streams. By building to the SumAll Partner API, partners ensure that their data is compatible with the SumAll processing and presentation, including hour/day/week roll-up and filters. 1
The Benefits The SumAll Partner API offers partners a high-quality, lightweight means to integrate with the SumAll platform. The partner’s users benefit by seeing partner data as a first-class citizen alongside data from other information sources.
Some of the specific benefits include:
•
Pushed-based solution (instead of polling) results in easier scaling
•
Strong SumAll data validation ensures that partner data meets the
•
Event and reporting-based APIs support flexible data extraction
•
Partner data automatically benefits from SumAll processing, includ-
•
Placement on SumAll platforms page (currently servicing some
• • • •
2
and more efficient use of resources.
requirements of SumAll data models and processing pipeline.
from partner data sources.
ing roll-ups and filters.
40,000 companies and growing at +1,100% yoy). Inclusion in all SumAll products (chart, email, mobile) Promotional/ marketing support from SumAll (press, blog, social) Ready, state of the art BI tooling leaving you to focus on your real business Quick check-ins for your customers across their key data
How to Integrate with the SumAll Partner API
SumAll connects data so that a customer can view their whole business in one chart. Make it easy for your customers to check in with you key data. By correlating revenue with analytics, social and other marketing levers, SumAll provides the key insights in real-time. Using the SumAll API, partners push changes and updates as they occur throughout the day. The SumAll chart immediately updates to reflect the latest data. 3
Provisioning
Pushing Reports
Provisioning is the first step required to use the SumAll
A report provides pre-aggregated user data for a
API. The provisioning process sets up the partner as a
specific time period. The expectation is that the partner
formal entity in the SumAll database, and creates and
will provide data for all time periods within a range.
assigns a unique platform type for the new integration.
Data for a time period for which data has already been received will replace the earlier data. Missing time peri-
The platform type defines the parameters and format
ods will be shown at the baseline on the chart.
of the data that make up the visible lines on the chart (range, units). This step also adds the partner to the
Pushing Events
SumAll platforms page, which makes it possible for any
Events are discrete occurrences characterized by a
SumAll user to locate and connect the partner data to
time and associated data. The SumAll processing pipe-
their SumAll account (sign-up). SumAll is responsible for
line will automatically aggregate event data. Duplicate
the work in this step, with input from Partner A.
events are treated as distinct events.
Reporting API The SumAll Reporting API is currently limited to reporting on the subset of SumAll users who have connected to a partner’s platform. The user information returned includes partner-specific information from the sign-up process (account id, credentials, token, etc.) as well as information about the state of the user’s data stream. Partner A will use the Reporting API to identify the users and the streams that need updates. Publishing API The SumAll Publishing API includes endpoints for pushing data. A particular partner’s data streams are configured to accept data in either report format or as a sequence of discrete events. The mechanics of both methods are identical, although the semantics differ. Partner A will use the Publishing API to push data to SumAll about each user’s data stream.
For further questions regarding the SumAll Partner API, contact [email protected]
4
sumall.com
The SumAll Partner API is a push-style API intended for SumAll partners who want to present their users’ data alongside data from other SumAll integrations (chart, email, mobile). The SumAll API exposes a small set of simple, secure HTTP endpoints for managing users and the data streams. By building to the SumAll Partner API, partners ensure that their data is compatible with the SumAll processing and presentation, including hour/day/week roll-up and filters. 1
The Benefits The SumAll Partner API offers partners a high-quality, lightweight means to integrate with the SumAll platform. The partner’s users benefit by seeing partner data as a first-class citizen alongside data from other information sources.
Some of the specific benefits include:
•
Pushed-based solution (instead of polling) results in easier scaling
•
Strong SumAll data validation ensures that partner data meets the
•
Event and reporting-based APIs support flexible data extraction
•
Partner data automatically benefits from SumAll processing, includ-
•
Placement on SumAll platforms page (currently servicing some
• • • •
2
and more efficient use of resources.
requirements of SumAll data models and processing pipeline.
from partner data sources.
ing roll-ups and filters.
40,000 companies and growing at +1,100% yoy). Inclusion in all SumAll products (chart, email, mobile) Promotional/ marketing support from SumAll (press, blog, social) Ready, state of the art BI tooling leaving you to focus on your real business Quick check-ins for your customers across their key data
How to Integrate with the SumAll Partner API
SumAll connects data so that a customer can view their whole business in one chart. Make it easy for your customers to check in with you key data. By correlating revenue with analytics, social and other marketing levers, SumAll provides the key insights in real-time. Using the SumAll API, partners push changes and updates as they occur throughout the day. The SumAll chart immediately updates to reflect the latest data. 3
Provisioning
Pushing Reports
Provisioning is the first step required to use the SumAll
A report provides pre-aggregated user data for a
API. The provisioning process sets up the partner as a
specific time period. The expectation is that the partner
formal entity in the SumAll database, and creates and
will provide data for all time periods within a range.
assigns a unique platform type for the new integration.
Data for a time period for which data has already been received will replace the earlier data. Missing time peri-
The platform type defines the parameters and format
ods will be shown at the baseline on the chart.
of the data that make up the visible lines on the chart (range, units). This step also adds the partner to the
Pushing Events
SumAll platforms page, which makes it possible for any
Events are discrete occurrences characterized by a
SumAll user to locate and connect the partner data to
time and associated data. The SumAll processing pipe-
their SumAll account (sign-up). SumAll is responsible for
line will automatically aggregate event data. Duplicate
the work in this step, with input from Partner A.
events are treated as distinct events.
Reporting API The SumAll Reporting API is currently limited to reporting on the subset of SumAll users who have connected to a partner’s platform. The user information returned includes partner-specific information from the sign-up process (account id, credentials, token, etc.) as well as information about the state of the user’s data stream. Partner A will use the Reporting API to identify the users and the streams that need updates. Publishing API The SumAll Publishing API includes endpoints for pushing data. A particular partner’s data streams are configured to accept data in either report format or as a sequence of discrete events. The mechanics of both methods are identical, although the semantics differ. Partner A will use the Publishing API to push data to SumAll about each user’s data stream.
For further questions regarding the SumAll Partner API, contact [email protected]
4
sumall.com
