TypeScript SDK#
The @brandwave/ts package is a fully-typed TypeScript client for the Brandwave API. It provides zero-dependency access to creator marketing data with automatic case conversion, pagination, and error handling.
Installation#
bash
npm install @brandwave/tsQuick setup#
typescript
import { createBrandwave } from '@brandwave/ts';
const bw = createBrandwave({
apiKey: process.env.BRANDWAVE_API_KEY,
});Authentication
Use API keys for server-side integrations, automation, and AI tools. Browser apps can pass the signed-in user's access token when they need to call Brandwave on behalf of that user.
Available resources#
The SDK organizes endpoints into resources. Each resource supports standard CRUD operations plus specialized queries.
- Activities — Track creator content activities and their performance across platforms.
- Activity log — Query activity log entries to track changes made across your organization.
- Campaigns — Group activities into campaigns for aggregate reporting.
- Conversion sources — Manage conversion sources (self-reported attribution surveys, UTM links, etc.) that attribute conversions to marketing activities.
- Conversions — Track conversion events attributed to influencer marketing activities.
- Costs — Read-only access to cost records across activities for reporting and analysis.
- Creators — Manage creators (influencers) with social media accounts across six platforms.
- Insights — Get intelligence and alerts about your organization to surface opportunities and risks.
- Notes — Create, read, update, and delete notes attached to activities, campaigns, or creators.
- Organizations — Manage organizations, team members, invitations, and organization-level settings.
- API keys — Create and manage API keys for server-side integrations.
- Reporting — Access calculated performance metrics and historical trends for organizations, campaigns, creators, and activities.
- Users — Manage user profiles and per-user settings.
Type exports
All types are exported directly from
@brandwave/ts. Import them with import type { Activity } from '@brandwave/ts'.