Athena_dashboard_apis NPM

athena_dashboard_apis

AthenaDashboardApis - JavaScript client for athena_dashboard_apis Athena Dashboard APIs This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0-SNAPSHOT
Package version: 1.0.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install athena_dashboard_apis --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your athena_dashboard_apis from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AthenaDashboardApis = require('athena_dashboard_apis');


var api = new AthenaDashboardApis.AnalysisApi()
var opts = {
  'createAnalysisRequest': new AthenaDashboardApis.CreateAnalysisRequest() // {CreateAnalysisRequest} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAnalysis(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/v1

Class	Method	HTTP request	Description
AthenaDashboardApis.AnalysisApi	createAnalysis	POST /analyses	创建内容特征分析报告
AthenaDashboardApis.AnalysisApi	deleteAnalysis	DELETE /analyses/{id}	删除内容特征分析报告
AthenaDashboardApis.AnalysisApi	getAnalysis	GET /analyses/{id}	查询内容特征分析报告详情
AthenaDashboardApis.AnalysisApi	getAnalysisContents	GET /analyses/{id}/contents	获取分析报告包含的内容
AthenaDashboardApis.AnalysisApi	getAuthorAnalysis	GET /analyses/{id}/authorAnalysis	以内容创作者类型和行业的维度进行分析
AthenaDashboardApis.AnalysisApi	getCharacteristicsAnalysis	GET /analyses/{id}/characteristicsAnalysis	以内容特征维度进行分析
AthenaDashboardApis.AnalysisApi	getFilterAnalysis	GET /analyses/{id}/filterAnalysis	以不同特征维度作为条件进行故事漏斗分析
AthenaDashboardApis.AnalysisApi	listAnalyses	GET /analyses	检索内容特征分析报告列表
AthenaDashboardApis.CollectionApi	createCollection	POST /collections	创建内容包
AthenaDashboardApis.CollectionApi	deleteCollection	DELETE /collections/{id}	删除内容包
AthenaDashboardApis.CollectionApi	getCollection	GET /collections/{id}	查询内容包
AthenaDashboardApis.CollectionApi	listCollections	GET /collections	查询内容包列表
AthenaDashboardApis.CollectionApi	listContentsInCollection	GET /collections/{id}/contents	查询内容包中的内容
AthenaDashboardApis.CollectionApi	updateCollection	PUT /collections/{id}	更新内容包
AthenaDashboardApis.ContentApi	getContent	GET /contents/{id}	获取内容详情信息
AthenaDashboardApis.ContentApi	getContentFanPersonas	GET /contents/{id}/personas	获取浏览过该内容的粉丝画像
AthenaDashboardApis.ContentApi	listContentRelatedBrands	GET /contents/{id}/brands	获取内容相关的品牌
AthenaDashboardApis.ContentApi	listRecommendKeys	GET /contents/recommendKeys	根据输入获取内容的热门标签(频数)
AthenaDashboardApis.ContentApi	listSimilarContents	GET /contents/{id}/similars	获取相似内容
AthenaDashboardApis.ContentApi	searchContents	GET /contents	根据条件和时间区间搜索热门内容
AthenaDashboardApis.ContentApi	searchContentsOptions	OPTIONS /contents	搜索热门内容API的参数信息
AthenaDashboardApis.HotspotApi	analyzeHotspotFans	GET /hotspots/{key}/fans	热词观众分析
AthenaDashboardApis.HotspotApi	analyzeHotspotKols	GET /hotspots/{key}/authors/analysis	热词相关达人分析
AthenaDashboardApis.HotspotApi	getHotspot	GET /hotspots/{key}	查询热点
AthenaDashboardApis.HotspotApi	getHotspotTrends	GET /hotspots/{key}/trends	热点相关指标趋势分析
AthenaDashboardApis.HotspotApi	listHotspotBrands	GET /hotspots/{key}/brands	热词相关品牌分析
AthenaDashboardApis.HotspotApi	listHotspotContents	GET /hotspots/{key}/contents	获取热词相关内容
AthenaDashboardApis.HotspotApi	listHotspotTopics	GET /hotspots/{key}/topics	热词相关话题分析
AthenaDashboardApis.HotspotApi	listRelatedHotspots	GET /hotspots/{key}/relatedHotspots	相关热点
AthenaDashboardApis.HotspotApi	searchHotspots	GET /hotspots	搜索热点
AthenaDashboardApis.HotspotApi	searchHotspotsOptions	OPTIONS /hotspots	搜索热点选项
AthenaDashboardApis.KOLApi	getAuthor	GET /authors/{id}	获取创作者详情分析
AthenaDashboardApis.KOLApi	getAuthorContentAnalysis	GET /authors/{id}/contentAnalysis	创作者内容发布和互动趋势分析
AthenaDashboardApis.KOLApi	getAuthorContentTimeAnalysis	GET /authors/{id}/authorContentTimeAnalysis	创作者作品时刻分析
AthenaDashboardApis.KOLApi	getAuthorContents	GET /authors/{id}/contents	获取创作者内容
AthenaDashboardApis.KOLApi	getAuthorFanPersonas	GET /authors/{id}/personas	获取创作者粉丝画像
AthenaDashboardApis.KOLApi	getAuthorTopicAnalysis	GET /authors/{id}/topics	创作者参与话题分析
AthenaDashboardApis.KOLApi	getBusinessAnalysis	GET /authors/{id}/businessAnalysis	创作者推广和商单分析
AthenaDashboardApis.KOLApi	listAuthorKeys	GET /authors/{id}/keys	列举创作者发表内容高频词
AthenaDashboardApis.KOLApi	searchAuthors	GET /authors	检索KOL
AthenaDashboardApis.KOLApi	searchAuthorsOptions	OPTIONS /authors	达人搜索API的参数信息