What was done with a partner's published widgets

Counts what the visitors of the compositions made through your account did in a period: how many times a composition was viewed, how many times a visitor interacted with one, and how many different visitors there were. It covers every composition of your account, your own and the ones made for your managed users; narrow it to one managed user with managedUserId or managedUserExternalId (not both).

The numbers come from the events the embedded widgets send while they are shown (the Widgetic embed SDK sends them by itself), counted when you ask. Only views and interactions are counted; the events that describe a visit (its start, its end, the device and the referrer) are not.

The period runs from startDate (included) to endDate (not included): the 30 days before now when you give neither, and at most 366 days. A date without a time is midnight UTC at the start of that day, so for all of October give startDate=2026-10-01 and endDate=2026-11-01.

The caller must be the person who administers the partner (an API key of that account works, with the partner:read scope), or a Widgetic administrator.

GET /partners/{partnerId}/analytics/summary

TypeScript SDK

TypeScript

import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';

const partnersApi = new PartnersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

// How the widgets of one customer did in October:
const { data: summary } = await partnersApi.getPartnerAnalyticsSummary({
  partnerId,
  startDate: '2026-10-01',
  endDate: '2026-11-01',
  managedUserExternalId: 'customer-4711'
});

console.log(summary.views, summary.interactions, summary.visitors);

200

{
  "success": true,
  "data": {
    "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "period": null,
    "managedUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "views": 42,
    "interactions": 42,
    "visitors": 42,
    "compositionsViewed": 42,
    "managedUsersViewed": 42
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId · string<uuid> · required

The partner whose widgets to report on

Query Parameters

startDate · string

Start of the period, included. An ISO 8601 date (2026-10-01) or date-time with its offset (2026-10-01T08:00:00Z). Default 30 days before endDate.

endDate · string

End of the period, not included, in the same forms. Default now. It must be after startDate, by at most 366 days.

managedUserId · string<uuid>

Report only on this managed user (Widgetic's id for the user). Send this or managedUserExternalId, not both.

managedUserExternalId · string

Report only on the managed user you registered with this externalId (your own identifier for the user). Send this or managedUserId, not both.

Maximum string length: 255

Response

200

application/json

What was done with the widgets in the period

success · boolean · required

Always true on a success.

Example:

true

data · object · required

What was done with the partner's published widgets in a period.

Show child attributes

Example:

{
  "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "period": null,
  "managedUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "views": 42,
  "interactions": 42,
  "visitors": 42,
  "compositionsViewed": 42,
  "managedUsersViewed": 42
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes