How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PixieBrix

PixieBrix Activity API

The activity API from PixieBrix — 23 operation(s) for activity.

Documentation Provider Profile APIs.io OpenAPI GitHub

PixieBrix Activity API is one of 31 APIs that PixieBrix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Activity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 28 operations across 23 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.pixiebrix.com.

28 operations 23 paths 28 schemas 3 DELETE19 GET1 PATCH3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.pixiebrix.com/api/
Contact
PixieBrix Support
Resource Areas
1

Paths & Operations 28

Across 23 paths, the API surfaces 28 operations — 3 DELETE, 19 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

activity 28
GET
/api/activity/policy/
Return the caller's merged effective activity policy for an organization (the additive union of all policies assigned to the user's groups). Gated by the activity-tracking organization feature flag.
retrieveEffectivePolicyResponse 1 param → 200
GET
/api/activity/corpus/
Return the prohibited-language matching corpus (term / category / severity) for the on-device outbound-text guard. Versioned; conditionally cacheable via an ETag / If-None-Match 304. Gated by the act…
retrieveProhibitedLanguageCorpus 1 param → 200
GET
/api/activity/custom-language-list/
Return the organization's Custom Language List (term / category / severity) for the on-device prohibited-language guard, which merges it into the matching engine alongside the curated corpus. Conditi…
listCustomLanguages 1 param → 200
PUT
/api/activity/custom-language-list/
Replace or upsert the caller's organization Custom Language List from a bulk upload. Each {term, category, severity} row's term is canonicalized (lowercase + trimmed) and duplicate terms in one batch…
updateCustomLanguageList body → 200
GET
/api/activity/address-list/match/
Look up on-device address hashes against the caller's organization known-address list. The caller sends one hash per match granularity (exact / building / street, computed on-device); the endpoint re…
listAddressListMatches 2 params → 200
GET
/api/activity/address-list/count/
Return a summary of the caller's organization known-address list — currently just count, the number of uploaded entries (distinct identifiers). Admin/manager + activity-tracking flag gated; scoped to…
listAddressListSummaries 1 param → 200
GET
/api/activity/policies/
Return the activity policies for an organization (organization query parameter). Restricted to organization admins/managers and gated by the activity-tracking flag.
listActivityPolicies 5 params → 200
POST
/api/activity/policies/
Create an activity policy for an organization. Restricted to organization admins/managers and gated by the activity-tracking flag.
createActivityPolicy body → 201
GET
/api/activity/policies/{id}/
Return a single activity policy. Restricted to organization admins/managers and gated by the activity-tracking flag.
retrieveActivityPolicy 1 param → 200
PATCH
/api/activity/policies/{id}/
Update an activity policy's name, assigned groups, or config. Changing the config bumps the policy version. Restricted to organization admins/managers and gated by the activity-tracking flag.
partialUpdateActivityPolicy 1 param body → 200
DELETE
/api/activity/policies/{id}/
Delete an activity policy. Restricted to organization admins/managers and gated by the activity-tracking flag.
destroyActivityPolicy 1 param → 204
GET
/api/activity/member-policies/
Return the activity policies that apply to a specific team member (those assigned to any of the member's groups), each with the group(s) the member belongs to that make it apply. Restricted to organi…
listMemberPolicies 2 params → 200
GET
/api/activity/reports/member-timeline/
Return a member's activity spans and events over the reporting window (start/end, default the last 7 days). When no window is given, a single date is honored instead (day boundaries in the optional t…
listMemberTimelines 6 params → 200
GET
/api/activity/reports/top-sites/
Return page-session domains ranked by focused time for a member (user) or across one or more groups (groups), else the whole organization. Restricted to organization admins/managers and gated by the…
listTopSites 6 params → 200
GET
/api/activity/reports/productivity/
Return the productivity score (share of focused-active time on productive sites) and the focused-time breakdown by class (productive/unproductive/neutral/unrated/mixed), for a member (user) or across…
listProductivitySummaries 5 params → 200
GET
/api/activity/reports/trends/
Return period-over-period trend series for the productivity score, focused time, in-tab activity level, and the productivity-class focused-time mix, bucketed by day (default) or week in the optional…
listProductivityTrends 7 params → 200
GET
/api/activity/reports/knowledge/
Return knowledge-base articles/videos referenced (the default Knowledge Referenced report), ranked by reference count, for a member (user) or across one or more groups (groups), else the whole organi…
listKnowledgeReferenceds 6 params → 200
GET
/api/activity/reports/handle-time/
Return handle time per task span and aggregated per agent, for a member (user) or across one or more groups (groups), else the whole organization. Handle time is a task span's wall-clock duration. Re…
listHandleTimes 6 params → 200
GET
/api/activity/reports/security/
Return security events (recorded by the Record Security Event brick and the policy-driven clipboard/URL-block/file-upload/protected-field enforcers) over the reporting window, newest first, for a mem…
listSecurityEvents 11 params → 200
GET
/api/activity/reports/security-event-context/
Return the activity context surrounding a single security event (event) — the enclosing trace's references and security events, plus other same-agent security events within a few minutes (any trace),…
listSecurityEventContexts 2 params → 200
GET
/api/activity/reports/shadow-ai/
Return shadow-AI usage rolled up per AI tool and per member from the on-device AI-prompt security events, for a member (user) or across one or more groups (groups), else the whole organization. Each…
listShadowAis 5 params → 200
GET
/api/activity/reports/trace/
Return all spans and events for a single trace (trace), scoped to the organization, for the trace-waterfall view. Restricted to organization admins/managers and gated by the activity-tracking flag.
listTraces 2 params → 200
GET
/api/activity/exports/{id}/
Return the status and result of an activity-data export job, including the signed download URL (data) once the job succeeds or the error message if it failed. Scoped to the user that requested the ex…
retrieveActivityExportJob 1 param → 200
POST
/api/activity/ingest/
Ingest a batch of activity spans and span events for an organization. Records are attributed to the authenticated user and stamped with the organization's resolved policy. Returns 202 Accepted with t…
createActivityIngest body → 202
POST
/api/activity/exports/
Start an asynchronous job that exports an organization's collected activity data (spans or events) to a downloadable CSV, returning the new job's id and initial status. Optionally scoped to a member,…
createActivityExportJob body → 201
PUT
/api/activity/address-list/
Replace or upsert the caller's organization known-address list from a self-service upload. The uploader hashes each address on-device (see libs/data-access-base/src/addressHashUtils.ts) and sends onl…
updateAddressListUpload body → 200
DELETE
/api/activity/address-list/
Clear the caller's organization known-address list, removing every address. Returns the number of addresses deleted. Admin/manager + activity-tracking flag gated; scoped to the caller's organization.
destroyAddressListUpload 1 param → 200
DELETE
/api/activity/data/
Delete all collected activity data (spans and events) for an organization (organization query parameter), leaving its activity policies intact. A development affordance for clearing prototype data; t…
destroyPurgeActivityData 1 param → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ProductivitySummaryResponse (10 properties), ActivityPolicy (9 properties), ProductivityTrendsResponse (9 properties), SecurityEventsResponse (9 properties). Each schema is shown below with its type and property counts.

SecurityEventsResponse
object
9 properties 9 required
AddressListUpload
object
3 properties 2 required
ShadowAiResponse
object
6 properties 6 required
CustomLanguageListUpload
object
3 properties 2 required
CustomLanguageListUploadResult
object
2 properties 2 required
CustomLanguageListEntry
object
3 properties 3 required
AddressListMatch
object
3 properties 2 required
ActivityExportJob
object
6 properties 2 required
KnowledgeReferencedResponse
object
4 properties 4 required
TraceResponse
object
6 properties 6 required
ProhibitedLanguageCorpus
object
2 properties 2 required
MemberPolicy
object
5 properties
HandleTimeResponse
object
5 properties 5 required
ActivityExportRequest
object
6 properties 1 required
MemberTimelineResponse
object
9 properties 9 required
AddressListSummary
object
1 property 1 required
AddressListClearResult
object
1 property 1 required
EffectivePolicyResponse
object
4 properties 4 required
ActivityIngestResult
object
2 properties 2 required
AddressListUploadResult
object
2 properties 2 required
ProductivityTrendsResponse
object
9 properties 9 required
TopSitesResponse
object
4 properties 4 required
ProductivitySummaryResponse
object
10 properties 10 required
ActivityIngest
object
3 properties 1 required
ActivityExportJobStarted
object
2 properties 2 required
PurgeActivityDataResponse
object
3 properties 3 required
ActivityPolicy
object
9 properties 2 required
SecurityEventContextResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-activity-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Audit API
AE Profile APIs.io
PixieBrix Bricks API
AE Profile APIs.io
PixieBrix Campaigns API
AE Profile APIs.io
PixieBrix Config API
AE Profile APIs.io
PixieBrix Control Rooms API
AE Profile APIs.io
PixieBrix Copilot API
AE Profile APIs.io
PixieBrix Databases API
AE Profile APIs.io
PixieBrix Deployments API
AE Profile APIs.io
PixieBrix Events API
AE Profile APIs.io
PixieBrix Groups API
AE Profile APIs.io
PixieBrix Health API
AE Profile APIs.io
PixieBrix Identify API
AE Profile APIs.io
#Activity
← Back to P APIs
API Details
ID
pixiebrix:pixiebrix-activity-api
Base URL
https://app.pixiebrix.com/api/
Docs
https://docs.pixiebrix.com/developer-api
Provider
PixieBrix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pixiebrix-activity-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pixiebrix-activity-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of PixieBrix Activity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.