Appearance
@line/bot-sdk / Exports / insight
Namespace: insight
Table of contents
Namespaces
- AgeTile
- AppTypeTile
- GenderTile
- GetNumberOfFollowersResponse
- GetNumberOfMessageDeliveriesResponse
- SubscriptionPeriodTile
Classes
Type Aliases
- AgeTile
- AppTypeTile
- AreaTile
- ErrorDetail
- ErrorResponse
- GenderTile
- GetFriendsDemographicsResponse
- GetMessageEventResponse
- GetMessageEventResponseClick
- GetMessageEventResponseMessage
- GetMessageEventResponseOverview
- GetNumberOfFollowersResponse
- GetNumberOfMessageDeliveriesResponse
- GetStatisticsPerUnitResponse
- GetStatisticsPerUnitResponseClick
- GetStatisticsPerUnitResponseMessage
- GetStatisticsPerUnitResponseOverview
- SubscriptionPeriodTile
Type Aliases
AgeTile
Ƭ AgeTile: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
age? | AgeEnum | users' age |
percentage? | number | Percentage |
Defined in
lib/insight/model/ageTile.ts:13
lib/insight/model/ageTile.ts:24
AppTypeTile
Ƭ AppTypeTile: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
appType? | AppTypeEnum | users' OS |
percentage? | number | Percentage |
Defined in
lib/insight/model/appTypeTile.ts:13
lib/insight/model/appTypeTile.ts:24
AreaTile
Ƭ AreaTile: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
area? | string | users' country and region |
percentage? | number | Percentage |
Defined in
lib/insight/model/areaTile.ts:13
ErrorDetail
Ƭ ErrorDetail: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
message? | string | Details of the error. Not included in the response under certain situations. |
property? | string | Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. |
Defined in
lib/insight/model/errorDetail.ts:13
ErrorResponse
Ƭ ErrorResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
details? | ErrorDetail[] | An array of error details. If the array is empty, this property will not be included in the response. See details Documentation |
message | string | Message containing information about the error. See message Documentation |
Defined in
lib/insight/model/errorResponse.ts:15
GenderTile
Ƭ GenderTile: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
gender? | GenderEnum | users' gender |
percentage? | number | Percentage |
Defined in
lib/insight/model/genderTile.ts:13
lib/insight/model/genderTile.ts:24
GetFriendsDemographicsResponse
Ƭ GetFriendsDemographicsResponse: Object
Get friend demographics
Type declaration
| Name | Type | Description |
|---|---|---|
ages? | AgeTile[] | Percentage per age group. See ages Documentation |
appTypes? | AppTypeTile[] | Percentage by OS. See appTypes Documentation |
areas? | AreaTile[] | Percentage per area. See areas Documentation |
available? | boolean | true if friend demographic information is available. See available Documentation |
genders? | GenderTile[] | Percentage per gender. See genders Documentation |
subscriptionPeriods? | SubscriptionPeriodTile[] | Percentage per friendship duration. See subscriptionPeriods Documentation |
Defined in
lib/insight/model/getFriendsDemographicsResponse.ts:22
GetMessageEventResponse
Ƭ GetMessageEventResponse: Object
Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
Type declaration
| Name | Type | Description |
|---|---|---|
clicks? | GetMessageEventResponseClick[] | Array of information about opened URLs in the message. See clicks Documentation |
messages? | GetMessageEventResponseMessage[] | Array of information about individual message bubbles. See messages Documentation |
overview? | GetMessageEventResponseOverview | See overview Documentation |
Defined in
lib/insight/model/getMessageEventResponse.ts:20
GetMessageEventResponseClick
Ƭ GetMessageEventResponseClick: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
click? | number | null | Number of times the URL was opened. |
seq? | number | The URL's serial number. |
uniqueClick? | number | null | Number of users that opened the URL. |
uniqueClickOfRequest? | number | null | Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once. |
url? | string | URL. |
Defined in
lib/insight/model/getMessageEventResponseClick.ts:13
GetMessageEventResponseMessage
Ƭ GetMessageEventResponseMessage: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
impression? | number | null | Number of times the bubble was displayed. |
mediaPlayed? | number | null | Number of times audio or video in the bubble started playing. |
mediaPlayed100Percent? | number | null | Number of times audio or video in the bubble started playing and was played 100% of the total time. |
mediaPlayed25Percent? | number | null | Number of times audio or video in the bubble started playing and was played 25% of the total time. |
mediaPlayed50Percent? | number | null | Number of times audio or video in the bubble started playing and was played 50% of the total time. |
mediaPlayed75Percent? | number | null | Number of times audio or video in the bubble started playing and was played 75% of the total time. |
seq? | number | Bubble's serial number. |
uniqueMediaPlayed? | number | null | Number of users that started playing audio or video in the bubble. |
uniqueMediaPlayed100Percent? | number | null | Number of users that started playing audio or video in the bubble and played 100% of the total time. |
uniqueMediaPlayed25Percent? | number | null | Number of users that started playing audio or video in the bubble and played 25% of the total time. |
uniqueMediaPlayed50Percent? | number | null | Number of users that started playing audio or video in the bubble and played 50% of the total time. |
uniqueMediaPlayed75Percent? | number | null | Number of users that started playing audio or video in the bubble and played 75% of the total time. |
Defined in
lib/insight/model/getMessageEventResponseMessage.ts:13
GetMessageEventResponseOverview
Ƭ GetMessageEventResponseOverview: Object
Summary of message statistics.
Type declaration
| Name | Type | Description |
|---|---|---|
delivered? | number | Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null. |
requestId? | string | Request ID. |
timestamp? | number | UNIX timestamp for message delivery time in seconds. |
uniqueClick? | number | null | Number of users who opened any URL in the message. |
uniqueImpression? | number | null | Number of users who opened the message, meaning they displayed at least 1 bubble. |
uniqueMediaPlayed? | number | null | Number of users who started playing any video or audio in the message. |
uniqueMediaPlayed100Percent? | number | null | Number of users who played the entirety of any video or audio in the message. |
Defined in
lib/insight/model/getMessageEventResponseOverview.ts:16
GetNumberOfFollowersResponse
Ƭ GetNumberOfFollowersResponse: Object
Get number of followers
Type declaration
| Name | Type | Description |
|---|---|---|
blocks? | number | The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account. See blocks Documentation |
followers? | number | The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account. See followers Documentation |
status? | StatusEnum | Calculation status. See status Documentation |
targetedReaches? | number | The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty. See targetedReaches Documentation |
Defined in
lib/insight/model/getNumberOfFollowersResponse.ts:16
lib/insight/model/getNumberOfFollowersResponse.ts:43
GetNumberOfMessageDeliveriesResponse
Ƭ GetNumberOfMessageDeliveriesResponse: Object
Get number of message deliveries
Type declaration
| Name | Type | Description |
|---|---|---|
apiBroadcast? | number | Number of broadcast messages sent with the Send broadcast message Messaging API operation. See apiBroadcast Documentation |
apiMulticast? | number | Number of multicast messages sent with the Send multicast message Messaging API operation. See apiMulticast Documentation |
apiNarrowcast? | number | Number of narrowcast messages sent with the Send narrowcast message Messaging API operation. See apiNarrowcast Documentation |
apiPush? | number | Number of push messages sent with the Send push message Messaging API operation. See apiPush Documentation |
apiReply? | number | Number of replies sent with the Send reply message Messaging API operation. See apiReply Documentation |
autoResponse? | number | Number of auto-response messages sent. See autoResponse Documentation |
broadcast? | number | Number of messages sent to all of this LINE Official Account's friends (broadcast messages). See broadcast Documentation |
chat? | number | Number of messages sent from LINE Official Account Manager Chat screen (only available in Japanese). See chat Documentation |
status? | StatusEnum | Status of the counting process. See status Documentation |
targeting? | number | Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages). See targeting Documentation |
welcomeResponse? | number | Number of greeting messages sent. See welcomeResponse Documentation |
Defined in
lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:16
lib/insight/model/getNumberOfMessageDeliveriesResponse.ts:85
GetStatisticsPerUnitResponse
Ƭ GetStatisticsPerUnitResponse: Object
Response object for get statistics per unit
Type declaration
| Name | Type | Description |
|---|---|---|
clicks | GetStatisticsPerUnitResponseClick[] | Array of information about opened URLs in the message. See clicks Documentation |
messages | GetStatisticsPerUnitResponseMessage[] | Array of information about individual message bubbles. See messages Documentation |
overview | GetStatisticsPerUnitResponseOverview | See overview Documentation |
Defined in
lib/insight/model/getStatisticsPerUnitResponse.ts:20
GetStatisticsPerUnitResponseClick
Ƭ GetStatisticsPerUnitResponseClick: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
click? | number | null | Number of times the URL in the bubble was opened. See click Documentation |
seq | number | The URL's serial number. See seq Documentation |
uniqueClick? | number | null | Number of users that opened the URL in the bubble. See uniqueClick Documentation |
uniqueClickOfRequest? | number | null | Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once. See uniqueClickOfRequest Documentation |
url | string | URL. See url Documentation |
Defined in
lib/insight/model/getStatisticsPerUnitResponseClick.ts:13
GetStatisticsPerUnitResponseMessage
Ƭ GetStatisticsPerUnitResponseMessage: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
impression? | number | null | Number of times the bubble was displayed. See impression Documentation |
mediaPlayed? | number | null | Number of times audio or video in the bubble started playing. See mediaPlayed Documentation |
mediaPlayed100Percent? | number | null | Number of times audio or video in the bubble started playing and was played 100% of the total time. See mediaPlayed100Percent Documentation |
mediaPlayed25Percent? | number | null | Number of times audio or video in the bubble started playing and was played 25% of the total time. See mediaPlayed25Percent Documentation |
mediaPlayed50Percent? | number | null | Number of times audio or video in the bubble started playing and was played 50% of the total time. See mediaPlayed50Percent Documentation |
mediaPlayed75Percent? | number | null | Number of times audio or video in the bubble started playing and was played 75% of the total time. See mediaPlayed75Percent Documentation |
seq | number | Bubble's serial number. See seq Documentation |
uniqueImpression? | number | null | Number of users the bubble was displayed. See uniqueImpression Documentation |
uniqueMediaPlayed? | number | null | Number of users that started playing audio or video in the bubble. See uniqueMediaPlayed Documentation |
uniqueMediaPlayed100Percent? | number | null | Number of users that started playing audio or video in the bubble and played 100% of the total time. See uniqueMediaPlayed100Percent Documentation |
uniqueMediaPlayed25Percent? | number | null | Number of users that started playing audio or video in the bubble and played 25% of the total time. See uniqueMediaPlayed25Percent Documentation |
uniqueMediaPlayed50Percent? | number | null | Number of users that started playing audio or video in the bubble and played 50% of the total time. See uniqueMediaPlayed50Percent Documentation |
uniqueMediaPlayed75Percent? | number | null | Number of users that started playing audio or video in the bubble and played 75% of the total time. See uniqueMediaPlayed75Percent Documentation |
Defined in
lib/insight/model/getStatisticsPerUnitResponseMessage.ts:13
GetStatisticsPerUnitResponseOverview
Ƭ GetStatisticsPerUnitResponseOverview: Object
Statistics related to messages.
Type declaration
| Name | Type | Description |
|---|---|---|
uniqueClick? | number | null | Number of users who opened any URL in the message. See uniqueClick Documentation |
uniqueImpression? | number | null | Number of users who opened the message, meaning they displayed at least 1 bubble. See uniqueImpression Documentation |
uniqueMediaPlayed? | number | null | Number of users who started playing any video or audio in the message. See uniqueMediaPlayed Documentation |
uniqueMediaPlayed100Percent? | number | null | Number of users who played the entirety of any video or audio in the message. See uniqueMediaPlayed100Percent Documentation |
Defined in
lib/insight/model/getStatisticsPerUnitResponseOverview.ts:16
SubscriptionPeriodTile
Ƭ SubscriptionPeriodTile: Object
LINE Messaging API(Insight) This document describes LINE Messaging API(Insight).
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
percentage? | number | Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6. |
subscriptionPeriod? | SubscriptionPeriodEnum | Subscription period. Possible values: within7days, within90days, unknown etc. |