Skip to main content

Applications API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
applicationsExternalRelatedGET /applications/external/related/applications/external/related [GET]
applicationsExternalSnapshotGET /applications/external/applications/external [GET]
applicationsRegister - (Deprecated)POST /applications/register/applications/register [POST]
applicationsSessionClose - (Deprecated)POST /applications/session/close/applications/session/close [POST]
applicationsSessionOpen - (Deprecated)POST /applications/session/open/applications/session/open [POST]
applicationsSessionSnapshot - (Deprecated)GET /applications/sessions/{session}/applications/sessions/{session} [GET]
applicationsSnapshotGET /applications/applications [GET]
applicationsSpecificApplicationSnapshotGET /applications/{application}/applications/{application} [GET]
applicationsUsageEngagementInteraction - (Deprecated)POST /applications/usage/engagement/interaction/applications/usage/engagement/interaction [POST] Scoped to Apps
applicationsUsageEngagementKeyboard - (Deprecated)POST /applications/usage/engagement/keyboard/applications/usage/engagement/keyboard [POST] Scoped to Apps
applicationsUsageInstallation - (Deprecated)POST /applications/usage/installation/applications/usage/installation [POST]
postApplicationsUsageUpdated - (Deprecated)POST /applications/usage/updated/applications/usage/updated [POST]

applicationsExternalRelated​

DetectedExternalApplications applicationsExternalRelated()

/applications/external/related [GET]

Retrieves a list of external applications installed on the user's machine that have potential integrations with Pieces, including those not yet installed by the user and those anticipated to be supported in the future.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();

try {
    final result = api_instance.applicationsExternalRelated();
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsExternalRelated: $e\n');
}

Parameters​

This endpoint does not need any parameter.

Return type​

DetectedExternalApplications

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json, text/plain

applicationsExternalSnapshot​

DetectedExternalApplications applicationsExternalSnapshot()

/applications/external [GET]

Provides a snapshot of all external applications detected on the user's machine, such as Microsoft Teams classic, Google Chat, Obsidian, etc.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();

try {
    final result = api_instance.applicationsExternalSnapshot();
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsExternalSnapshot: $e\n');
}

Parameters​

This endpoint does not need any parameter.

Return type​

DetectedExternalApplications

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json, text/plain

applicationsRegister - (Deprecated)​

Application applicationsRegister(application)

/applications/register [POST]

Registers a new application within the Pieces ecosystem.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final application = Application(); // Application | This will accept a application.

try {
    final result = api_instance.applicationsRegister(application);
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsRegister: $e\n');
}

Parameters​

NameTypeDescriptionNotes
applicationApplicationThis will accept a application.[optional]

Return type​

Application

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

applicationsSessionClose - (Deprecated)​

Session applicationsSessionClose(body)

/applications/session/close [POST]

Closes an active session, identified by a session UUID, marking the end of the user's current interaction with the Pieces application.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final body = String(); // String | This will accept a required session uuid.

try {
    final result = api_instance.applicationsSessionClose(body);
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsSessionClose: $e\n');
}

Parameters​

NameTypeDescriptionNotes
bodyStringThis will accept a required session uuid.[optional]

Return type​

Session

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

applicationsSessionOpen - (Deprecated)​

Session applicationsSessionOpen()

/applications/session/open [POST]

Initiates a new session, marking the start of a user's interaction with the Pieces application.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();

try {
    final result = api_instance.applicationsSessionOpen();
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsSessionOpen: $e\n');
}

Parameters​

This endpoint does not need any parameter.

Return type​

Session

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

applicationsSessionSnapshot - (Deprecated)​

Session applicationsSessionSnapshot(session)

/applications/sessions/{session} [GET]

Fetches detailed information about a specific session, identified by a session UUID, including application usage and engagement data.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final session = session_example; // String | This is a uuid that points to a session.

try {
    final result = api_instance.applicationsSessionSnapshot(session);
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsSessionSnapshot: $e\n');
}

Parameters​

NameTypeDescriptionNotes
sessionStringThis is a uuid that points to a session.

Return type​

Session

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

applicationsSnapshot​

Applications applicationsSnapshot()

/applications [GET]

Retrieves a comprehensive overview of all applications tracked by the Pieces system, including status, version, and engagement metrics.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();

try {
    final result = api_instance.applicationsSnapshot();
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsSnapshot: $e\n');
}

Parameters​

This endpoint does not need any parameter.

Return type​

Applications

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

applicationsSpecificApplicationSnapshot​

Application applicationsSpecificApplicationSnapshot(application)

/applications/{application} [GET]

Obtains a snapshot with information about a specific application, identified by its UUID.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final application = application_example; // String | This is a uuid that represents an application

try {
    final result = api_instance.applicationsSpecificApplicationSnapshot(application);
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsSpecificApplicationSnapshot: $e\n');
}

Parameters​

NameTypeDescriptionNotes
applicationStringThis is a uuid that represents an application

Return type​

Application

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

applicationsUsageEngagementInteraction - (Deprecated)​

TrackedInteractionEvent applicationsUsageEngagementInteraction(seededTrackedInteractionEvent)

/applications/usage/engagement/interaction [POST] Scoped to Apps

Records user interaction events within applications, such as clicks or taps, to analyze engagement patterns and user behavior.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final seededTrackedInteractionEvent = SeededTrackedInteractionEvent(); // SeededTrackedInteractionEvent | 

try {
    final result = api_instance.applicationsUsageEngagementInteraction(seededTrackedInteractionEvent);
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsUsageEngagementInteraction: $e\n');
}

Parameters​

NameTypeDescriptionNotes
seededTrackedInteractionEventSeededTrackedInteractionEvent[optional]

Return type​

TrackedInteractionEvent

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

applicationsUsageEngagementKeyboard - (Deprecated)​

TrackedKeyboardEvent applicationsUsageEngagementKeyboard(seededTrackedKeyboardEvent)

/applications/usage/engagement/keyboard [POST] Scoped to Apps

Captures keyboard interaction events, including shortcuts, within applications to monitor user engagement and productivity enhancements.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final seededTrackedKeyboardEvent = SeededTrackedKeyboardEvent(); // SeededTrackedKeyboardEvent | 

try {
    final result = api_instance.applicationsUsageEngagementKeyboard(seededTrackedKeyboardEvent);
    print(result);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsUsageEngagementKeyboard: $e\n');
}

Parameters​

NameTypeDescriptionNotes
seededTrackedKeyboardEventSeededTrackedKeyboardEvent[optional]

Return type​

TrackedKeyboardEvent

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

applicationsUsageInstallation - (Deprecated)​

applicationsUsageInstallation(trackedApplicationInstall)

/applications/usage/installation [POST]

Logs the installation events of the Pieces application.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final trackedApplicationInstall = TrackedApplicationInstall(); // TrackedApplicationInstall | 

try {
    api_instance.applicationsUsageInstallation(trackedApplicationInstall);
} catch (e) {
    print('Exception when calling ApplicationsApi->applicationsUsageInstallation: $e\n');
}

Parameters​

NameTypeDescriptionNotes
trackedApplicationInstallTrackedApplicationInstall[optional]

Return type​

void (empty response body)

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: Not defined

postApplicationsUsageUpdated - (Deprecated)​

postApplicationsUsageUpdated(trackedApplicationUpdate)

/applications/usage/updated [POST]

Tracks updates to the Pieces application, including version changes.

Example​

import 'package:core_openapi/api.dart';

final api_instance = ApplicationsApi();
final trackedApplicationUpdate = TrackedApplicationUpdate(); // TrackedApplicationUpdate | Sending over the previous application version, the current version, and the user.

try {
    api_instance.postApplicationsUsageUpdated(trackedApplicationUpdate);
} catch (e) {
    print('Exception when calling ApplicationsApi->postApplicationsUsageUpdated: $e\n');
}

Parameters​

NameTypeDescriptionNotes
trackedApplicationUpdateTrackedApplicationUpdateSending over the previous application version, the current version, and the user.[optional]

Return type​

void (empty response body)

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: application/json
  • Accept: Not defined