{"id":19653542,"url":"https://github.com/sematext/sematext-api-client-javascript","last_synced_at":"2025-07-11T15:43:21.292Z","repository":{"id":42460193,"uuid":"260438863","full_name":"sematext/sematext-api-client-javascript","owner":"sematext","description":"Sematext API Client for Node.js","archived":false,"fork":false,"pushed_at":"2024-07-22T14:34:20.000Z","size":1577,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-06-18T03:15:50.726Z","etag":null,"topics":["alerting","api-client","cloud","javascript","log-shipping","monitoring"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sematext.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-01T11:03:44.000Z","updated_at":"2023-06-07T01:56:14.000Z","dependencies_parsed_at":"2025-04-28T17:49:35.057Z","dependency_job_id":null,"html_url":"https://github.com/sematext/sematext-api-client-javascript","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/sematext/sematext-api-client-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sematext","download_url":"https://codeload.github.com/sematext/sematext-api-client-javascript/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-javascript/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264842856,"owners_count":23672076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alerting","api-client","cloud","javascript","log-shipping","monitoring"],"created_at":"2024-11-11T15:14:27.457Z","updated_at":"2025-07-11T15:43:21.267Z","avatar_url":"https://github.com/sematext.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"https://sematext.com/wp-content/uploads/2020/09/just-octi-blue.png\" valign=\"bottom\" width=\"60px\"/\u003e**\u0026nbsp;\u0026nbsp;sematext-api-client-javascript**\n\n\u003cbr\u003e\n\n\u003e _A [Sematext Cloud](https://sematext.com/cloud/) API client, for interaction with Sematext Cloud solution monitoring, alerting and log shipping._\n\n\u003cbr\u003e\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\u003cbr\u003e\nOne of a family of clients in following flavours:\n\u003cbr\u003e\n\u003cbr\u003e\n\n- [sematext-api-client-javascript](https://github.com/sematext/sematext-api-client-javascript 'Javascript')\n- [sematext-api-client-rust](https://github.com/sematext/sematext-api-client-rust 'Rust')\n- [sematext-api-client-ruby](https://github.com/sematext/sematext-api-client-ruby 'Ruby')\n- [sematext-api-client-python](https://github.com/sematext/sematext-api-client-python 'Python')\n- [sematext-api-client-php](https://github.com/sematext/sematext-api-client-php 'PHP')\n- [sematext-api-client-java](https://github.com/sematext/sematext-api-client-java 'Java')\n- [sematext-api-client-go](https://github.com/sematext/sematext-api-client-go 'Go/Golang')\n\n\u003cbr\u003e\nRefer to below link for deeper information on the API itself.\n\u003cbr\u003e\n\u003cbr\u003e\n\n- [Sematext Cloud API Reference](https://sematext.com/docs/api/ 'API Reference')\n\n\u003cbr\u003e\n\n## Contents\n\n- [\u003cimg src=\"https://sematext.com/wp-content/uploads/2020/09/just-octi-blue.png\" valign=\"bottom\" width=\"60px\"/\u003e**\u0026nbsp;\u0026nbsp;sematext-api-client-javascript**](#sematext-api-client-javascript)\n  - [Contents](#contents)\n  - [Getting Started](#getting-started)\n    - [Installation](#installation)\n      - [_Node.js_](#nodejs)\n      - [_Webpack Configuration_](#webpack-configuration)\n  - [Authentication](#authentication)\n  - [Testing](#testing)\n  - [Documentation for API Endpoints](#documentation-for-api-endpoints)\n  - [Documentation for Models](#documentation-for-models)\n\n\u003cbr\u003e\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n\u003cbr\u003e\n\n### Installation\n\n#### _Node.js_\n\nInstall via:\n\n```shell\nnpm install @sematext/sematext-api-client --save\n```\n\n```shell\nconst Stcloud = require(\"@sematext/sematext-api-client\")\n```\n\n\u003cbr\u003e\n\n#### _Webpack Configuration_\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n## Authentication\n\nThis client code requires a Sematext API Access token to function. You can find this by logging into your [Sematext Cloud Account](https://apps.sematext.com/ui/account/api)\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar SematextApiClientJavascript = require('sematext-api-client-javascript')\n\nvar defaultClient = SematextApiClientJavascript.ApiClient.instance\n\n// Configure API key authorization: api_key\nvar api_key = defaultClient.authentications['api_key']\napi_key.apiKey = 'YOUR API KEY'\n// Uncomment the following line to set a prefix for the API key, e.g. \"Token\" (defaults to null)\n//api_key.apiKeyPrefix['Authorization'] = \"Token\"\n\nvar api = new SematextApiClientJavascript.AlertNotificationsApi()\n\nvar appId = 789 // {Number} appId\n\nvar timeInterval = new SematextApiClientJavascript.AlertNotificationRequest() // {AlertNotificationRequest} Time Interval\n\napi.getAlertNotificationsForAppUsingPOST(appId, timeInterval).then(\n  function (data) {\n    console.log('API called successfully. Returned data: ' + data)\n  },\n  function (error) {\n    console.error(error)\n  }\n)\n```\n\n\u003cbr\u003e\u003cbr\u003e\n\n## Testing\n\nNote: Tests are currently inhibited by a Mocha dependancy on Yargs.\nThis client is generated code so this should have litle impact.\nMarking as a pre-release until this is resolved upstream.\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n## Documentation for API Endpoints\n\nAll URIs are relative to _https://localhost_\n\n| Class                                                  | Method                                                                                                             | HTTP request                                                          | Description                                                                                             |\n| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |\n| _SematextApiClientJavascript.AlertNotificationsApi_    | [**getAlertNotificationsForAppUsingPOST**](docs/AlertNotificationsApi.md#getAlertNotificationsForAppUsingPOST)     | **POST** /users-web/api/v3/apps/{appId}/notifications/alerts          | Get alert notifications for an app                                                                      |\n| _SematextApiClientJavascript.AlertNotificationsApi_    | [**getAlertNotificationsForUserUsingPOST1**](docs/AlertNotificationsApi.md#getAlertNotificationsForUserUsingPOST1) | **POST** /users-web/api/v3/notifications/alerts                       | Get alert notifications for a user                                                                      |\n| _SematextApiClientJavascript.AlertsApi_                | [**createAlertUsingPOST**](docs/AlertsApi.md#createAlertUsingPOST)                                                 | **POST** /users-web/api/v3/alerts                                     | Create alert rule                                                                                       |\n| _SematextApiClientJavascript.AlertsApi_                | [**deleteAlertRuleUsingDELETE**](docs/AlertsApi.md#deleteAlertRuleUsingDELETE)                                     | **DELETE** /users-web/api/v3/alerts/{updateableAlertId}               | Delete alert rule                                                                                       |\n| _SematextApiClientJavascript.AlertsApi_                | [**disableAlertRuleUsingPUT**](docs/AlertsApi.md#disableAlertRuleUsingPUT)                                         | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/disable          | Disable alert rule                                                                                      |\n| _SematextApiClientJavascript.AlertsApi_                | [**enableAlertRuleUsingPUT1**](docs/AlertsApi.md#enableAlertRuleUsingPUT1)                                         | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/enable           | Enable alert rule                                                                                       |\n| _SematextApiClientJavascript.AlertsApi_                | [**getAlertRulesForAppUsingGET**](docs/AlertsApi.md#getAlertRulesForAppUsingGET)                                   | **GET** /users-web/api/v3/apps/{appId}/alerts                         | Get alert rules for an app                                                                              |\n| _SematextApiClientJavascript.AppsApi_                  | [**deleteUsingDELETE**](docs/AppsApi.md#deleteUsingDELETE)                                                         | **DELETE** /users-web/api/v3/apps/{anyStateAppId}                     | delete                                                                                                  |\n| _SematextApiClientJavascript.AppsApi_                  | [**getAppTypesUsingGET1**](docs/AppsApi.md#getAppTypesUsingGET1)                                                   | **GET** /users-web/api/v3/apps/types                                  | Get all App types supported for the account identified with apiKey                                      |\n| _SematextApiClientJavascript.AppsApi_                  | [**getUsingGET**](docs/AppsApi.md#getUsingGET)                                                                     | **GET** /users-web/api/v3/apps/{anyStateAppId}                        | Gets defails for one particular App                                                                     |\n| _SematextApiClientJavascript.AppsApi_                  | [**inviteAppGuestsUsingPOST**](docs/AppsApi.md#inviteAppGuestsUsingPOST)                                           | **POST** /users-web/api/v3/apps/guests                                | Invite guests to an app                                                                                 |\n| _SematextApiClientJavascript.AppsApi_                  | [**listAppsUsersUsingGET1**](docs/AppsApi.md#listAppsUsersUsingGET1)                                               | **GET** /users-web/api/v3/apps/users                                  | Get all users of apps accessible to this account                                                        |\n| _SematextApiClientJavascript.AppsApi_                  | [**listUsingGET1**](docs/AppsApi.md#listUsingGET1)                                                                 | **GET** /users-web/api/v3/apps                                        | Get all apps accessible by account identified with apiKey                                               |\n| _SematextApiClientJavascript.AppsApi_                  | [**updateDescriptionUsingPUT1**](docs/AppsApi.md#updateDescriptionUsingPUT1)                                       | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description            | Update description of the app                                                                           |\n| _SematextApiClientJavascript.AppsApi_                  | [**updateUsingPUT2**](docs/AppsApi.md#updateUsingPUT2)                                                             | **PUT** /users-web/api/v3/apps/{anyStateAppId}                        | Update app                                                                                              |\n| _SematextApiClientJavascript.AwsSettingsControllerApi_ | [**updateUsingPUT**](docs/AwsSettingsControllerApi.md#updateUsingPUT)                                              | **PUT** /users-web/api/v3/apps/{appId}/aws                            | Update App's AWS CloudWatch settings                                                                    |\n| _SematextApiClientJavascript.BillingApi_               | [**getDetailedInvoiceUsingGET**](docs/BillingApi.md#getDetailedInvoiceUsingGET)                                    | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month}    | Get invoice details                                                                                     |\n| _SematextApiClientJavascript.BillingApi_               | [**listAvailablePlansUsingGET1**](docs/BillingApi.md#listAvailablePlansUsingGET1)                                  | **GET** /users-web/api/v3/billing/availablePlans                      | Get available plans                                                                                     |\n| _SematextApiClientJavascript.BillingApi_               | [**updatePlanUsingPUT1**](docs/BillingApi.md#updatePlanUsingPUT1)                                                  | **PUT** /users-web/api/v3/billing/info/{appId}                        | Update plan for an app                                                                                  |\n| _SematextApiClientJavascript.LogsAppApi_               | [**createLogseneApplication**](docs/LogsAppApi.md#createLogseneApplication)                                        | **POST** /logsene-reports/api/v3/apps                                 | Create Logs App                                                                                         |\n| _SematextApiClientJavascript.MonitoringAppApi_         | [**createSpmApplication1**](docs/MonitoringAppApi.md#createSpmApplication1)                                        | **POST** /spm-reports/api/v3/apps                                     | Create Monitoring App                                                                                   |\n| _SematextApiClientJavascript.ResetPasswordApi_         | [**resetPasswordUsingPOST**](docs/ResetPasswordApi.md#resetPasswordUsingPOST)                                      | **POST** /users-web/api/v3/account/password/reset                     | Reset Password                                                                                          |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**createForAppUsingPOST**](docs/SubscriptionsApi.md#createForAppUsingPOST)                                        | **POST** /users-web/api/v3/apps/{appId}/subscription                  | Create App subscription                                                                                 |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**createForDashUsingPOST1**](docs/SubscriptionsApi.md#createForDashUsingPOST1)                                    | **POST** /users-web/api/v3/dashboards/{dashId}/subscription           | Create dashboard subscription                                                                           |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**deleteUsingDELETE2**](docs/SubscriptionsApi.md#deleteUsingDELETE2)                                              | **DELETE** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription                                                                                     |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**listUsingGET3**](docs/SubscriptionsApi.md#listUsingGET3)                                                        | **GET** /users-web/api/v3/apps/{appId}/subscriptions                  | Get subscriptions for an App                                                                            |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**listUsingGET4**](docs/SubscriptionsApi.md#listUsingGET4)                                                        | **GET** /users-web/api/v3/subscriptions                               | Get current account's subscriptions                                                                     |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**sendAppReportUsingPOST1**](docs/SubscriptionsApi.md#sendAppReportUsingPOST1)                                    | **POST** /users-web/api/v3/apps/{appId}/report/send                   | Email an App report                                                                                     |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**sendDashReportUsingPOST**](docs/SubscriptionsApi.md#sendDashReportUsingPOST)                                    | **POST** /users-web/api/v3/dashboards/{dashId}/report/send            | Email a dashboard report                                                                                |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**toggleEnabledUsingPUT1**](docs/SubscriptionsApi.md#toggleEnabledUsingPUT1)                                      | **PUT** /users-web/api/v3/subscriptions/{updateableSubscriptionId}    | Toggle subscription status                                                                              |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**updateForAppUsingPUT**](docs/SubscriptionsApi.md#updateForAppUsingPUT)                                          | **PUT** /users-web/api/v3/apps/{appId}/subscription                   | Update App subscription                                                                                 |\n| _SematextApiClientJavascript.SubscriptionsApi_         | [**updateForDashUsingPUT1**](docs/SubscriptionsApi.md#updateForDashUsingPUT1)                                      | **PUT** /users-web/api/v3/dashboards/{dashId}/subscription            | Update dashboard subscription                                                                           |\n| _SematextApiClientJavascript.TagApiControllerApi_      | [**getTagNamesUsingGET1**](docs/TagApiControllerApi.md#getTagNamesUsingGET1)                                       | **GET** /spm-reports/api/v3/apps/{appIds}/tagNames                    | Gets tag names for the given application identifiers appearing in the given time frame.                 |\n| _SematextApiClientJavascript.TagApiControllerApi_      | [**getUsingGET1**](docs/TagApiControllerApi.md#getUsingGET1)                                                       | **GET** /spm-reports/api/v3/apps/{appIds}/tags                        | Gets values for specified tags for the given application identifiers appearing in the given time frame. |\n| _SematextApiClientJavascript.TagApiControllerApi_      | [**getUsingGET2**](docs/TagApiControllerApi.md#getUsingGET2)                                                       | **GET** /spm-reports/api/v3/apps/{appIds}/metrics/filters             | Gets values for specified tags for the given application identifiers appearing in the given time frame. |\n| _SematextApiClientJavascript.TokensApiControllerApi_   | [**createAppToken1**](docs/TokensApiControllerApi.md#createAppToken1)                                              | **POST** /users-web/api/v3/apps/{appId}/tokens                        | Create new app token                                                                                    |\n| _SematextApiClientJavascript.TokensApiControllerApi_   | [**deleteAppToken1**](docs/TokensApiControllerApi.md#deleteAppToken1)                                              | **DELETE** /users-web/api/v3/apps/{appId}/tokens/{tokenId}            | Delete app token                                                                                        |\n| _SematextApiClientJavascript.TokensApiControllerApi_   | [**getAppTokens**](docs/TokensApiControllerApi.md#getAppTokens)                                                    | **GET** /users-web/api/v3/apps/{appId}/tokens                         | Get app available tokens                                                                                |\n| _SematextApiClientJavascript.TokensApiControllerApi_   | [**regenerateAppToken**](docs/TokensApiControllerApi.md#regenerateAppToken)                                        | **POST** /users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate   | Regenerate app token)                                                                                   |\n| _SematextApiClientJavascript.TokensApiControllerApi_   | [**updateAppToken1**](docs/TokensApiControllerApi.md#updateAppToken1)                                              | **PUT** /users-web/api/v3/apps/{appId}/tokens/{tokenId}               | Update app token (enable/disable or name)                                                               |\n\n## Documentation for Models\n\n- [SematextApiClientJavascript.AlertNotificationRequest](docs/AlertNotificationRequest.md)\n- [SematextApiClientJavascript.AlertRule](docs/AlertRule.md)\n- [SematextApiClientJavascript.AlertRuleScheduleTimeRangeDto](docs/AlertRuleScheduleTimeRangeDto.md)\n- [SematextApiClientJavascript.AlertRuleScheduleWeekdayDto](docs/AlertRuleScheduleWeekdayDto.md)\n- [SematextApiClientJavascript.App](docs/App.md)\n- [SematextApiClientJavascript.AppDescription](docs/AppDescription.md)\n- [SematextApiClientJavascript.AppMetadata](docs/AppMetadata.md)\n- [SematextApiClientJavascript.BasicAuthMethodDto](docs/BasicAuthMethodDto.md)\n- [SematextApiClientJavascript.BasicOrganizationDto](docs/BasicOrganizationDto.md)\n- [SematextApiClientJavascript.BillingInfo](docs/BillingInfo.md)\n- [SematextApiClientJavascript.CloudWatchSettings](docs/CloudWatchSettings.md)\n- [SematextApiClientJavascript.CreateAppInfo](docs/CreateAppInfo.md)\n- [SematextApiClientJavascript.CreateTokenDto](docs/CreateTokenDto.md)\n- [SematextApiClientJavascript.Error](docs/Error.md)\n- [SematextApiClientJavascript.FilterValue](docs/FilterValue.md)\n- [SematextApiClientJavascript.GenericApiResponse](docs/GenericApiResponse.md)\n- [SematextApiClientJavascript.Invitation](docs/Invitation.md)\n- [SematextApiClientJavascript.NotificationIntegration](docs/NotificationIntegration.md)\n- [SematextApiClientJavascript.Plan](docs/Plan.md)\n- [SematextApiClientJavascript.ReportInfo](docs/ReportInfo.md)\n- [SematextApiClientJavascript.ServiceIntegration](docs/ServiceIntegration.md)\n- [SematextApiClientJavascript.SubscriptionDashboardDto](docs/SubscriptionDashboardDto.md)\n- [SematextApiClientJavascript.SubscriptionDto](docs/SubscriptionDto.md)\n- [SematextApiClientJavascript.UpdateAppInfo](docs/UpdateAppInfo.md)\n- [SematextApiClientJavascript.UpdateSubscriptionDto](docs/UpdateSubscriptionDto.md)\n- [SematextApiClientJavascript.UpdateTokenDto](docs/UpdateTokenDto.md)\n- [SematextApiClientJavascript.UserInfo](docs/UserInfo.md)\n- [SematextApiClientJavascript.UserPermissions](docs/UserPermissions.md)\n- [SematextApiClientJavascript.UserRole](docs/UserRole.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsematext%2Fsematext-api-client-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsematext%2Fsematext-api-client-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsematext%2Fsematext-api-client-javascript/lists"}