@usesummit/next v0.4.5

Summit JS SDK

Summit powers engaging apps for sales, marketing, and product teams to deploy and use anywhere.

You can use this SDK to call your Summit apps over API from your website or apps. The SDK isn't mandatory but ensures a correct configuration for Summit's analytics and CRM integration features.

🌱 The Summit SDK is fresh out of the oven and in an alpha state. Things might change at any time, but we're happy to collaborate on your implementation and make sure we don't break things going forward. You can reach me at pieter.beulque@usesummit.com if you're planning on rolling out your own implementation and have questions or concerns.

Usage

Initializing

Initialize a Summit client instance by running:

import Summit from '@usesummit/sdk';

const summit = new Summit('your-optional-api-key');

Running

Run your app by calling summit.run() with these options:

• app: { app: 'org-slug/id/app-slug', apiKey: 'app-api-key' }. You can get this information from the API tab in the project settings dialog. The apiKey is optional if you've initialized the client with an API key.
• parameters: a dictionary with your app's parameters. If your leave out any parameters, it will run using the default values in the Summit model driving the app logic.
• options: { start?: 'iso-string', end?: 'iso-string', resolution?: 'month' | 'year' | … }

run() returns a Promise that resolves into an object with this structure:

{
  groups: {
    from: number;
    to: number;
    title: string;
    is_partial: boolean;
  }[],
  results: {
    group: string; // Refers to `groups[].title`
    values: Record<string, number>
  }[]
}

You can read more on the API input & output in our API documentation.