Skip to content

Commit 7360ed6

Browse files
authored
Merge branch 'master' into button-documentation
2 parents 871bf43 + c981ae4 commit 7360ed6

File tree

3 files changed

+44
-1
lines changed

3 files changed

+44
-1
lines changed

src/connections/spec/common.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,4 +392,4 @@ The `receivedAt` timestamp is most important as the sort key in our Warehouses p
392392

393393
The `timestamp` timestamp specifies when the datapoint occurred, corrected for client-device clock skew. This is the timestamp that is passed to downstream destinations and used for historical replays. It is important to use this timestamp for importing historical data to the API.
394394

395-
If you are using the Segment server Source libraries, or passing calls directly to the HTTP API endpoint, you can manually set the `timestamp` field. If you are using a Segment Source in device mode, the library generates `timestamp` and you cannot manually set one directly in the call payload. However, for mobile sources, you can use Middleware ([Middleware for iOS](/docs/connections/sources/libraries/mobile/ios/middleware/), [Middleware for Android](/docs/connections/sources/libraries/mobile/ios/middleware/)) to modify the payload, including the timestamp. (You might manually set or override a timestamp to import historical data to the Segment API).
395+
If you are using the Segment server Source libraries, or passing calls directly to the HTTP API endpoint, you can manually set the `timestamp` field. If you are using a Segment Source in device mode, the library generates `timestamp` and you cannot manually set one directly in the call payload.
107 KB
Loading

src/segment-app/workspace-home.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Workspace Home
3+
hidden: true
4+
---
5+
6+
Segment’s Workspace Home serves as a dashboard that gives you a single consolidated view of the workspace, its health and status, and metrics for specific integrations, within the last 24 hours.
7+
8+
> info ""
9+
> The Workspace Home is available only to Business tier customers, and is only visible for [Workspace Owners](/docs/segment-app/iam/roles/). If you have access to the Home page, it is the first screen you see when you first log in to your Segment Workspace.
10+
11+
The Home page shows a summary of errors in the workspace’s sources and destinations, a list of “favorite” integrations that you can configure, and information about recent audit logged events, and your billing plan usage.
12+
13+
![](/docs/segment-app/images/workspace-home.png)
14+
15+
16+
## Sources - Violations
17+
18+
The Sources section of the Home pages shows a summary of the event volume flowing through Segment.
19+
20+
If your Segment plan includes Protocols, the dashboard shows [Event Violations](/docs/protocols/validate/review-violations/) occurring in the workspace, including a graph over time. You can click into the violations section to see a list of sources ordered from highest number of violations, to lowest. You can click into individual sources to see more details and go to their individual source pages, or [go to the Violations page](https://app.segment.com/goto-my-workspace/protocols/violations).
21+
22+
## Destinations - Event Delivery
23+
24+
The Destinations section of the Home page shows a summary of the Event Delivery for the workspace, including a graph over time. You can click the **destinations** link to see a list of destinations with delivery problems, ordered from highest to lowest error rate. You can click a destination to see more details about the delivery failures, and from the details panel click the destination name to go directly to its configuration page.
25+
26+
## Favorite integrations
27+
28+
If you have access to the Workspace Home page, you can customize it for yourself by bookmarking or saving “favorite” integrations. These could be sources, destinations, storage destinations, and functions that you work with regularly, or want to monitor closely.
29+
30+
These Home page favorites are specific to your user account in the workspace. The are not shared among administrators in the same workspace, and are not accessible from other workspaces you might be an administrator for.
31+
32+
To create a favorite, click **Add Favorite** or the plus icon, and select the integration(s) to bookmark. The list that appears displays a status icon for each integration, so you can tell which ones are healthy (green) and unhealthy (red), and which ones are inactive (gray).
33+
34+
Once you create a favorite, the section displays your favorites in tabs so you can view sources only, destinations only (including storage destinations), or all of them at once. Each favorite displays important configuration details and summary statistics for that integration. You can click the **more** (…) menu to jump directly to one of the configuration or detail pages for that integration.
35+
36+
To delete a favorite, click the **more** (…) menu and select **Remove favorite**.
37+
38+
## Recent Activity
39+
40+
The recent activity section displays the most recent items logged to the Segment Audit trail. This includes workspace membership changes and requests, changes to the configuration of different Segment features (including sources, destinations, and to Personas and Protocols configurations), and data storage sync failures.
41+
42+
## Usage
43+
The Usage section shows a summary of the workspace’s plan utilization for the current billing period. This includes billing information for all parts of your Segment plan. This includes MTUs or API call volume, Functions usage time (if applicable), and Personas details (if applicable). Click **view all** to go to the workspace’s billing page for more detailed statistics.

0 commit comments

Comments
 (0)