Skip to content

Commit 6fd0fb0

Browse files
authored
Documentation edits made through Mintlify web editor
1 parent cc6831a commit 6fd0fb0

1 file changed

Lines changed: 28 additions & 15 deletions

File tree

x-api/activity/introduction.mdx

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Introduction
33
sidebarTitle: Introduction
4-
54
---
65

76
The X Activity API (XAA) endpoint group allows developers to tap in to activity events happening on the X Platform.
@@ -23,19 +22,33 @@ The X Activity API currently supports the following delivery mechanisms to send
2322

2423
## Supported Event Types
2524

26-
Currenrtly, X Activity API supports the following profile update events, shown here:
25+
Currently, X Activity API supports the following event types, organized by category:
26+
27+
### Profile Events
28+
29+
Profile events are triggered when a user makes changes to their profile information.
2730

28-
| Category | Event Name | Description |
31+
| Event Name | Description | Filters |
2932
| --- | --- | --- |
30-
| Profile | `ProfileBioUpdate` | Fired when a user updates their profile bio |
31-
| Profile | `ProfilePictureUpdate` | Fired when a user updates their profile picture |
32-
| Profile | `ProfileBannerUpdate` | Fired when a user updates their profile banner |
33-
| Profile | `ProfileGeoUpdate` | Fired when a user updates their profile location |
34-
| Profile | `ProfileUrlUpdate` | Fired when a user updates their profile website URL |
35-
| Profile | `ProfileScreennameUpdate` | Fired when a user updates their display name |
36-
| Profile | `ProfileVerifiedBadgeUpdate` | Fired when a user updates their verified badge |
37-
| Trends | `TrendsNew` | New grok-curated trends and headlines |
33+
| `ProfileBioUpdate` | Fired when a user updates their profile bio | `user_id` |
34+
| `ProfilePictureUpdate` | Fired when a user updates their profile picture | `user_id` |
35+
| `ProfileBannerUpdate` | Fired when a user updates their profile banner | `user_id` |
36+
| `ProfileGeoUpdate` | Fired when a user updates their profile location | `user_id` |
37+
| `ProfileUrlUpdate` | Fired when a user updates their profile website URL | `user_id` |
38+
| `ProfileScreennameUpdate` | Fired when a user updates their display name | `user_id` |
39+
| `ProfileVerifiedBadgeUpdate` | Fired when a user updates their verified badge | `user_id` |
40+
41+
### Trends Events
42+
43+
Trends events provide updates on trending topics and headlines curated by Grok.
3844

45+
| Event Name | Description | Filters |
46+
| --- | --- | --- |
47+
| `TrendsNew` | New grok-curated trends and headlines | `keyword` |
48+
49+
<Note>
50+
**Enterprise Only:** The `TrendsNew` event is only available to Enterprise and Partner tier accounts at this time.
51+
</Note>
3952

4053
In future releases, XAA will expand to support additional event types including social interactions, content engagement, monetization features, and more. We will continue to update our docs when new event types become available.
4154

@@ -83,14 +96,14 @@ The X Activity API has different subscription limits based on your account tier:
8396

8497
To access these endpoints, you will need:
8598

86-
* An approved [developer account](https://developer.x.com/en/portal/petition/essential/basic-info).
87-
* To authenticate using the keys and tokens from a [developer App](/resources/fundamentals/developer-apps) that is located within a [Project](/resources/fundamentals/projects). 
99+
* An approved [developer account](https://developer.x.com/en/portal/petition/essential/basic-info).
100+
* To authenticate using the keys and tokens from a [developer App](/resources/fundamentals/developer-apps) that is located within a [Project](/resources/fundamentals/projects).
88101

89-
Learn more about getting access to the X API v2 endpoints in our [getting started guide](/x-api/getting-started/getting-access).
102+
Learn more about getting access to the X API v2 endpoints in our [getting started guide](/x-api/getting-started/getting-access).
90103
</Note>
91104

92105
<div className="flex">
93106
<Button href="/x-api/posts/filtered-stream/quickstart">
94107
Quick start
95108
</Button>
96-
</div>
109+
</div>

0 commit comments

Comments
 (0)