You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/guides/intro-admin.md
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ If your job is to set up or maintain a Segment Workspace for your organization,
7
7
## What is Segment?
8
8
9
9
> info ""
10
-
> If youread the [detailed explanation of Segment](/docs/guides/) on the previous page, you can skip ahead!
10
+
> If you've already read [an Introduction to Segment](/docs/guides/), you can skip ahead.
11
11
12
-
Segment is a system for sending messages from your websites, mobile apps, and servers. These messages contain data about events on, or users of those systems, and these messages can sent on to other tools, and gathered together in a warehouse for later analysis. Segment can also bring in information about your users from external systems, such as helpdesks or CRM systems, and collate that information to help you analyze your data, build audiences of users, and personalize your users' experiences.
12
+
Segment is a system for sending messages from your websites, mobile apps, and servers. These messages contain event and user data that you can send to other tools or collect in warehouses for further analysis. Segment also gathers information about your users from external systems, like helpdesks or CRMs. You can use this collated information to analyze data, build user audiences, and personalize your users' experiences.
13
13
14
14
## What's a Workspace?
15
15
@@ -20,23 +20,23 @@ Segment is a system for sending messages from your websites, mobile apps, and se
20
20
21
21
You don't have to be a developer to be a Workspace administrator for an organization, and this guide only covers tasks specifically related to managing a Workspace in the [Segment App](/docs/segment-app/).
22
22
23
-
However, many Workspace admins are also involved in the Segment implementation process as there are usually some tasks that must be performed in the Workspace to complete an implementation. If you think you might be developing a Segment implementation or helping out other developers, it's a good idea to [read the Segment developer intro](/docs/guides/intro-impl/)!
23
+
However, many Workspace admins are also involved in the Segment implementation process as there are usually some tasks that must be performed in the Workspace to complete an implementation. If you think you might develop a Segment implementation or help out other developers, first read [Segment for developers](/docs/guides/intro-impl/).
24
24
25
25
> note ""
26
26
> **Note**: Workspace roles are only available to Business Tier customers. If you're on a Free or Team plan, all workspace members are granted workspace administrator access.
27
27
28
28
In addition, Workspace administrators set up and maintain the organization's [workspace settings](https://app.segment.com/goto-my-workspace/settings/), which include:
29
29
- Billing information and billing contacts
30
30
- Incident contacts - the people who get notified in the event of an outage or incident
31
-
-the Workspace name and slug - the display name and namespace of the workspace in the Segment system
31
+
-The Workspace name and slug - the display name and namespace of the workspace in the Segment system
32
32
33
33
> info ""
34
-
> Changing the workspace name and slug do not have any effect on any sources or destinations already set up and configured. (These use a combination of an internal ID, and `writeKey` to connect.)
34
+
> Changing a workspace name and slug won't impact configured sources or destinations, which connect using an internal ID and `writeKey`.
35
35
36
36
Workspace administrators might also maintain:
37
37
-**The organization's authentication settings**. This can include login settings, multi-factor authentication enforcement, Identity provider (IDP) settings (including SAML and OAuth), and other related settings.
38
38
-**Access Management settings**. Business-tier plans include object-, group-, and role-based [access management settings](/docs/segment-app/iam/), Segment workspace "environments" and labels, roles and groups, and the general permissions model.
39
-
-**Billing information**. If your Workspace is on a Team plan, you might have access to a billing page, where you can update the credit card on file, or change other billing details.
39
+
-**Billing information**. If your Workspace is on a Team plan, you might have access to a billing page, where you can update the credit card on file or change other billing details.
40
40
41
41
42
42
## Tasks in Connections
@@ -45,19 +45,21 @@ As an administrator, you might be asked to help other members of your organizati
45
45
46
46
### Setting up destinations
47
47
48
-
Destinations are the endpoint to which Segment sends data flowing from your Sources, and represent external tools (such as Google Analytics, Mixpanel, etc) and sometimes bulk-storage destinations like warehouses. You can set up a Destination from within the Segment App, by navigating to the [Destination Catalog](https://app.segment.com/goto-my-workspace/destinations/catalog) and selecting the tool you want to set up. In most cases, you'll need an existing API key or token, so Segment can send the data to the correct account. If you're setting up a Warehouse or other storage destination, more steps might be required, so see the [Warehouses documentation](/docs/connections/storage/warehouses/) for more details.
48
+
Destinations are the endpoints to which Segment sends data flowing from your Sources. Destinations can be third-party external tools, like Google Analytics or Mixpanel, or bulk-storage resources, like warehouses.
49
+
50
+
You can set up a Destination from within the Segment App by navigating to the [Destination Catalog](https://app.segment.com/goto-my-workspace/destinations/catalog) and selecting the tool you want to set up. In most cases, you'll need an existing API key or token so that Segment can send the data to the correct account. If you're setting up a Warehouse or other storage destination, more steps might be required; see the [Warehouses documentation](/docs/connections/storage/warehouses/) for more details.
49
51
50
52
### Troubleshooting
51
53
52
-
Segment contains several ways to see what's going on in your Workspace:
54
+
Use these Segment features to keep tabs on your Workspace:
53
55
54
56
-**[Workspace Health](https://app.segment.com/goto-my-workspace/integration-health/)** - if there are any problems with sources or destinations in your workspace, they'll show up here.
55
-
-**[Event Tester](/docs/connections/test-connections/)** - The Event tester allows you to troubleshoot both your Sources and their configuration, and the destiantions they send to. The Event Tester shows a sample of the data available, so you can check that it's being sent, and that it's in the correct format.
57
+
-**[Event Tester](/docs/connections/test-connections/)** - The Event tester allows you to troubleshoot your Sources, their configuration, and their downstream destinations. The Event Tester shows a sample of the data available, so you can check that it's being sent, and that it's in the correct format.
56
58
-**[Event Delivery](/docs/connections/event-delivery/)** - Event Delivery is a bit like the Event Tester, but specifically for determining if [rules or filters](/docs/guides/filtering-data/) within Segment are preventing data from getting to a destination.
57
-
-Last but not least, check out our list of [integration error codes](/docs/connections/integration_error_codes/) for clues about what might be causing an error.
59
+
-Check out Segment's list of [integration error codes](/docs/connections/integration_error_codes/) for insight into what might cause an error.
58
60
59
61
> info ""
60
-
> Still stumped? [Contact us](https://segment.com/help/contact/) for more help troubleshooting!
62
+
> Still stumped? [Contact support](https://segment.com/help/contact/) for more help troubleshooting.
61
63
62
64
63
65
<!-- TODO
@@ -70,4 +72,4 @@ protocols set up and maintenance
70
72
Privacy monitoring
71
73
-->
72
74
> success ""
73
-
> Have suggestions for things to add to this guide? [Drop us a line](mailto:[email protected]?subject=Segment%20Admin%20guide%20Suggestion)!
75
+
> Have suggestions for this guide? [Reach out with your feedback](mailto:[email protected]?subject=Segment%20Admin%20guide%20Suggestion).
Copy file name to clipboardExpand all lines: src/guides/usage-and-billing/account-management.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,41 +4,45 @@ title: Account Management
4
4
5
5
## What is the difference between an account and a workspace?
6
6
7
-
An account is associated to a single user, and is attached to the email address you sign up with. A workspace houses all of your sources, and can have one or several user accounts as owners and/or read-only members.
7
+
An account is associated to a single user and is attached to the email address you sign up with. A workspace houses all of your sources, and can have one or several user accounts as owners and/or read-only members.
8
8
9
9
## What if I change my domain name?
10
10
11
-
You don't need to do anything if you change your domain – for example, if you change your domain from www.mysite.com to www.mysuperawesomesite.com. If you want the new domain to be used as the same Segment source, just make sure you use the same Segment write key that you used with the old domain.
11
+
You don't need to do anything if you change your domain name. If the new domain name will serve as the same Segment source, make sure you use the same Segment write key that you used with the old domain.
12
12
13
-
You may claim ownership of your domain for the purposes of Single Sign On login association, but it currently has no bearing on data collection.
13
+
You may claim ownership of your domain for the purposes of single sign-on login association, but it currently has no bearing on data collection.
14
14
15
-
## I'm on a Legacy API plan, why can't I add the integration I want?
15
+
## I'm on a legacy API plan. Why can't I add the integration I want?
16
16
17
-
Only users on our legacy API based plans will run into integration limits. Some of our older plans placed limitations on the integrations you could use. If you would like to add an integration that is not available on your current planmove to a new Team plan where all integrations are included along with several other additional features.
17
+
Some of Segment's previous plans, including the legacy API plan, limited integration usage. If you want to add an integration that's not available on your current plan, move to a new Team plan. Team plans include all integrations, along with other additional features.
18
18
19
19
## Will deleting my account cancel my subscription?
20
20
21
-
No, deleting your account will only stop you from accessing workspaces through your login. The workspace is where the subscription is managed, and it will not be deleted. Data will still flow into Segment and your Destinations and you will still be charged if you delete your account but don't delete your workspace.
21
+
No. Deleting your account only stops you from accessing workspaces through your login. The workspace is where the subscription is managed, and it will not be deleted. Data will still flow into Segment and your Destinations, and you will still be charged if you delete your account but don't delete your workspace.
22
22
23
23
## How do I delete my workspace entirely?
24
24
25
-
To delete your workspace, go your [Workspace's Settings](https://app.segment.com/goto-my-workspace/settings/basic), click the "General" tab, and click **Delete Workspace**.
25
+
To delete your workspace, go your [Workspace Settings](https://app.segment.com/goto-my-workspace/settings/basic), click the **General** tab, then click **Delete Workspace**.
26
26
27
27
You should also change your write keys for each source and remove all Segment snippets from your codebase.
28
28
29
+
## What happens if I change my workspace name or slug?
30
+
31
+
Changing your workspace name or slug won't impact any sources or destinations you've already configured. If you're using [Segment's Config API](/docs/config-api/), though, you'll need to change the slug in your request URLs.
32
+
29
33
## Can I recover a source or workspace after I delete it?
30
34
31
-
No, once a source or workspace is deleted it cannot be recovered.
35
+
No. Deleted sources and workspaces cannot be recovered.
32
36
33
37
## Can I move a source from one workspace to another?
34
38
35
-
Segment doesn't have the ability to "merge" workspaces, however you can achieve the same effect by moving your existing sources to a single workspace. You might do this to unify all of your data across your team(s) to better track your customer data as a complete picture.
39
+
Though workspaces can't be merged, you can move an existing source to a single workspace to the same effect. For example, you might move existing sources to one workspace so that you can unify all of your data across teams and gain a broader view of your customer data tracking.
36
40
37
-
You can move sources between workspaces going to the Settings for the source, clicking Transfer to Workspace in the left navigation. Choose the workspace you want to move the source to, and click **Transfer Source**.
41
+
To move a source between workspaces, navigate to the source's **Settings** tab, then click **Transfer to Workspace**. Choose the workspace you're moving the source to, then click **Transfer Source**.
38
42
39
43
> info ""
40
-
> **Note**: The person who transfers the source must be a [workspace owner](/docs/segment-app/iam/) for both the origin and recipient workspaces, otherwise the recipient workspace won't appear in the dropdown list.
44
+
> The person who transfers the source must be a [workspace owner](/docs/segment-app/iam/) for both the origin and recipient workspaces, otherwise the recipient workspace won't appear in the dropdown list.
41
45
42
-

46
+

43
47
44
-
When you transfer the source, all destination configurations are removed. Be sure to set up the destinations you want after the transfer.
48
+
Transferring a source removes all associated destination configurations. Be sure to set up the destinations you want after the transfer.
0 commit comments