Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Client pour les opérations sur les publications
Ce client fournit des méthodes pour interagir avec les points de terminaison (endpoints) des publications
de la X API. Il gère l’authentification, le formatage des requêtes et l’analyse des réponses
pour l’ensemble des opérations liées aux publications.
• new PostsClient(client): PostsClient
Crée une nouvelle instance de PostsClient
| Nom | Type | Description |
|---|
client | Client | L’instance principale du Client de la X API |
Renvoie
PostsClient
Défini dans
posts/client.ts:789
▸ getInsights28hr(tweetIds, granularity, requestedMetrics, options): Promise<Response>
Obtenir les statistiques de Publications sur 28 heures
Récupère les métriques d’engagement pour les Publications spécifiées sur les 28 dernières heures.
| Nom | Type | Description |
|---|
tweetIds | any[] | Liste d’id de Publication pour les métriques sur 28 h. |
granularity | string | Granularité de la réponse des métriques. |
requestedMetrics | any[] | Métriques demandées pour la requête historique. |
options | GetInsights28hrOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
posts/client.ts:842
▸ getInsights28hr(tweetIds, granularity, requestedMetrics, options?): Promise<Get2Insights28hrResponse>
| Nom | Type |
|---|
tweetIds | any[] |
granularity | string |
requestedMetrics | any[] |
options? | GetInsights28hrOptions |
Renvoie
Promise<Get2Insights28hrResponse>
Défini dans
posts/client.ts:863
▸ getAnalytics(ids, endTime, startTime, granularity, options): Promise<Response>
Obtenir les analyses de Publications
Récupère les données d’analyse pour les Publications spécifiées sur une période définie.
| Name | Type | Description |
|---|
ids | any[] | Une liste d’ID de Publication séparés par des virgules. Jusqu’à 100 sont autorisés dans une seule requête. |
endTime | string | YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant la fin de la plage temporelle. |
startTime | string | YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant le début de la plage temporelle. |
granularity | string | La granularité des résultats de comptage de recherche. |
options | GetAnalyticsOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw vaut true
Défini dans
posts/client.ts:1052
▸ getAnalytics(ids, endTime, startTime, granularity, options?): Promise<Analytics>
| Nom | Type |
|---|
ids | any[] |
endTime | string |
startTime | string |
granularity | string |
options? | GetAnalyticsOptions |
Renvoie
Promise<Analytics>
Défini dans
posts/client.ts:1077
▸ getReposts(id, options): Promise<Response>
Obtenir les republications
Renvoie une liste de Publications qui republient une Publication spécifique identifiée par son ID.
| Nom | Type | Description |
|---|
id | string | Un seul identifiant de Publication. |
options | GetRepostsOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
posts/client.ts:1271
▸ getReposts(id, options?): Promise<Get2TweetsIdRetweetsResponse>
| Nom | Type |
|---|
id | string |
options? | GetRepostsOptions |
Renvoie
Promise<Get2TweetsIdRetweetsResponse>
Défini dans
posts/client.ts:1284
▸ searchRecent(query, options): Promise<Response>
Rechercher des Publications récentes
Récupère les Publications des 7 derniers jours qui correspondent à une requête de recherche.
| Nom | Type | Description |
|---|
query | string | Une requête/règle/filtre pour faire correspondre des Publications. Reportez-vous à https://t.co/rulelength pour connaître la longueur maximale autorisée d’une requête. |
options | SearchRecentOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou avec l’objet Response brut si requestOptions.raw vaut true
Défini dans
posts/client.ts:1559
▸ searchRecent(query, options?): Promise<Get2TweetsSearchRecentResponse>
| Nom | type |
|---|
query | string |
options? | SearchRecentOptions |
Renvoie
Promise<Get2TweetsSearchRecentResponse>
Défini dans
posts/client.ts:1572
▸ searchAll(query, options): Promise<Response>
Rechercher toutes les Publications
Récupère les Publications de l’archive complète qui correspondent à une requête de recherche.
| Nom | Type | Description |
|---|
query | string | Une requête/règle/filtre pour faire correspondre des Publications. Consultez https://t.co/rulelength pour déterminer la longueur maximale de la requête. |
options | SearchAllOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est défini sur true
Défini dans
posts/client.ts:1968
▸ searchAll(query, options?): Promise<Get2TweetsSearchAllResponse>
| Nom | Type |
|---|
query | string |
options? | SearchAllOptions |
Renvoie
Promise<Get2TweetsSearchAllResponse>
Défini dans
posts/client.ts:1981
▸ getByIds(ids, options): Promise<Response>
Récupérer des Publications par identifiants
Récupère les détails de plusieurs Publications à partir de leurs identifiants.
| Nom | Type | Description |
|---|
ids | any[] | Une liste d’identifiants de Publication, séparés par des virgules. Jusqu’à 100 éléments sont autorisés par requête. |
options | GetByIdsOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true
Défini dans
posts/client.ts:2365
▸ getByIds(ids, options?): Promise<Get2TweetsResponse>
| Nom | Type |
|---|
ids | any[] |
options? | GetByIdsOptions |
Renvoie
Promise<Get2TweetsResponse>
Défini dans
posts/client.ts:2378
▸ create(body, options): Promise<Response>
Créer ou modifier une Publication
Crée une nouvelle Publication pour l’utilisateur authentifié, ou modifie une Publication existante si des edit_options sont fournies.
| Nom | Type | Description |
|---|
body | TweetCreateRequest | Corps de la requête |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Renvoie
Promise<Response>
Promise se résolvant avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
posts/client.ts:2622
▸ create(body): Promise<TweetCreateResponse>
Renvoie
Promise<TweetCreateResponse>
Défini dans
posts/client.ts:2633
▸ getQuoted(id, options): Promise<Response>
Obtenir les Publications qui citent une autre Publication
Récupère la liste des Publications qui citent une Publication spécifique, à partir de son identifiant.
| Nom | Type | Description |
|---|
id | string | Un identifiant unique de Publication. |
options | GetQuotedOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est défini sur true
Défini dans
posts/client.ts:2718
▸ getQuoted(id, options?): Promise<Get2TweetsIdQuoteTweetsResponse>
| Nom | Type |
|---|
id | string |
options? | GetQuotedOptions |
Renvoie
Promise<Get2TweetsIdQuoteTweetsResponse>
Défini dans
posts/client.ts:2731
▸ getCountsRecent(query, options): Promise<Response>
Obtenir le nombre de Publications récentes
Récupère le nombre de Publications correspondant à une requête de recherche sur les 7 derniers jours.
| Nom | Type | Description |
|---|
query | string | Une requête/règle/filtre pour des Publications correspondantes. Consultez https://t.co/rulelength pour déterminer la longueur maximale de la requête. |
options | GetCountsRecentOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
posts/client.ts:3025
▸ getCountsRecent(query, options?): Promise<Get2TweetsCountsRecentResponse>
| Nom | Type |
|---|
query | string |
options? | GetCountsRecentOptions |
Renvoie
Promise<Get2TweetsCountsRecentResponse>
Défini dans
posts/client.ts:3038
▸ hideReply(tweetId, options): Promise<Response>
Masquer une réponse
Masque ou rétablit l’affichage d’une réponse dans une conversation dont l’utilisateur authentifié est propriétaire.
| Nom | Type | Description |
|---|
tweetId | string | L’identifiant de la réponse que vous souhaitez masquer ou afficher de nouveau. |
options | HideReplyOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true
Défini dans
posts/client.ts:3298
▸ hideReply(tweetId, options?): Promise<TweetHideResponse>
| Nom | Type |
|---|
tweetId | string |
options? | HideReplyOptions |
Renvoie
Promise<TweetHideResponse>
Défini dans
posts/client.ts:3311
▸ getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options): Promise<Response>
Obtenir des insights historiques sur des Publications
Récupère les métriques d’engagement historiques pour les Publications spécifiées sur une plage temporelle définie.
| Nom | Type | Description |
|---|
tweetIds | any[] | Liste d’identifiants de Publications pour le calcul des métriques historiques. |
endTime | string | YYYY-MM-DDTHH:mm:ssZ. Horodatage UTC représentant la fin de l’intervalle de temps. |
startTime | string | YYYY-MM-DDTHH:mm:ssZ. Horodatage UTC représentant le début de l’intervalle de temps. |
granularity | string | Granularité des métriques renvoyées. |
requestedMetrics | any[] | Métriques demandées pour la requête historique. |
options | GetInsightsHistoricalOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promesse résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true
Défini dans
posts/client.ts:3435
▸ getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options?): Promise<Get2InsightsHistoricalResponse>
| Nom | Type |
|---|
tweetIds | any[] |
endTime | string |
startTime | string |
granularity | string |
requestedMetrics | any[] |
options? | GetInsightsHistoricalOptions |
Renvoie
Promise<Get2InsightsHistoricalResponse>
Défini dans
posts/client.ts:3464
▸ getCountsAll(query, options): Promise<Response>
Obtient le nombre total de Publications
Récupère le nombre de Publications correspondant à une requête de recherche à partir de l’archive complète.
| Nom | Type | Description |
|---|
query | string | Une requête/règle/filtre permettant de faire correspondre des Publications. Reportez-vous à https://t.co/rulelength pour déterminer la longueur maximale d’une requête. |
options | GetCountsAllOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true
Défini dans
posts/client.ts:3679
▸ getCountsAll(query, options?): Promise<Get2TweetsCountsAllResponse>
| Nom | Type |
|---|
query | string |
options? | GetCountsAllOptions |
Renvoie
Promise<Get2TweetsCountsAllResponse>
Défini dans
posts/client.ts:3692
▸ getById(id, options): Promise<Response>
Obtenir une Publication par son ID
Renvoie les détails d’une Publication spécifique à partir de son ID.
| Nom | Type | Description |
|---|
id | string | Un identifiant unique de Publication. |
options | GetByIdOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
posts/client.ts:3952
▸ getById(id, options?): Promise<Get2TweetsIdResponse>
| Nom | Type |
|---|
id | string |
options? | GetByIdOptions |
Renvoie
Promise<Get2TweetsIdResponse>
Défini dans
posts/client.ts:3965
▸ delete(id, options): Promise<Response>
Supprimer une publication
Supprime une publication spécifique par son identifiant, si elle appartient à l’utilisateur authentifié.
Parameters
| Name | Type | Description |
|---|
id | string | Identifiant (id) de la Publication à supprimer. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Renvoie
Promise<Response>
Promesse qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true
Défini dans
posts/client.ts:4202
▸ delete(id): Promise<TweetDeleteResponse>
Promise<TweetDeleteResponse>
Défini dans
posts/client.ts:4215
▸ getLikingUsers(id, options): Promise<Response>
Obtenir les utilisateurs qui ont aimé
Récupère la liste des utilisateurs qui ont aimé une Publication donnée à partir de son identifiant.
| Nom | Type | Description |
|---|
id | string | L’identifiant d’une Publication unique. |
options | GetLikingUsersOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
posts/client.ts:4306
▸ getLikingUsers(id, options?): Promise<Get2TweetsIdLikingUsersResponse>
| Nom | Type |
|---|
id | string |
options? | GetLikingUsersOptions |
Renvoie
Promise<Get2TweetsIdLikingUsersResponse>
Défini dans
posts/client.ts:4319
▸ getRepostedBy(id, options): Promise<Response>
Obtenir les comptes ayant repartagé
Récupère la liste des utilisateurs qui ont repartagé une Publication spécifique à partir de son id.
| Nom | Type | Description |
|---|
id | string | Identifiant d’une seule Publication. |
options | GetRepostedByOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est true
Défini dans
posts/client.ts:4525
▸ getRepostedBy(id, options?): Promise<Get2TweetsIdRetweetedByResponse>
| Nom | Type |
|---|
id | string |
options? | GetRepostedByOptions |
Renvoie
Promise<Get2TweetsIdRetweetedByResponse>
posts/client.ts:4538
