LINE Messaging API SDK for PHP

InsightApi
in package

LINE

Clients

Insight

InsightApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['getFriendsDemographics' => ['application/json...

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
getConfig() : Configuration
getFriendsDemographics() : GetFriendsDemographicsResponse: Operation getFriendsDemographics
getFriendsDemographicsAsync() : PromiseInterface: Operation getFriendsDemographicsAsync
getFriendsDemographicsAsyncWithHttpInfo() : PromiseInterface: Operation getFriendsDemographicsAsyncWithHttpInfo
getFriendsDemographicsRequest() : Request: Create request for operation 'getFriendsDemographics'
getFriendsDemographicsWithHttpInfo() : array<string|int, mixed>: Operation getFriendsDemographicsWithHttpInfo
getHostIndex() : int: Get the host index
getMessageEvent() : GetMessageEventResponse: Operation getMessageEvent
getMessageEventAsync() : PromiseInterface: Operation getMessageEventAsync
getMessageEventAsyncWithHttpInfo() : PromiseInterface: Operation getMessageEventAsyncWithHttpInfo
getMessageEventRequest() : Request: Create request for operation 'getMessageEvent'
getMessageEventWithHttpInfo() : array<string|int, mixed>: Operation getMessageEventWithHttpInfo
getNumberOfFollowers() : GetNumberOfFollowersResponse: Operation getNumberOfFollowers
getNumberOfFollowersAsync() : PromiseInterface: Operation getNumberOfFollowersAsync
getNumberOfFollowersAsyncWithHttpInfo() : PromiseInterface: Operation getNumberOfFollowersAsyncWithHttpInfo
getNumberOfFollowersRequest() : Request: Create request for operation 'getNumberOfFollowers'
getNumberOfFollowersWithHttpInfo() : array<string|int, mixed>: Operation getNumberOfFollowersWithHttpInfo
getNumberOfMessageDeliveries() : GetNumberOfMessageDeliveriesResponse: Operation getNumberOfMessageDeliveries
getNumberOfMessageDeliveriesAsync() : PromiseInterface: Operation getNumberOfMessageDeliveriesAsync
getNumberOfMessageDeliveriesAsyncWithHttpInfo() : PromiseInterface: Operation getNumberOfMessageDeliveriesAsyncWithHttpInfo
getNumberOfMessageDeliveriesRequest() : Request: Create request for operation 'getNumberOfMessageDeliveries'
getNumberOfMessageDeliveriesWithHttpInfo() : array<string|int, mixed>: Operation getNumberOfMessageDeliveriesWithHttpInfo
getRichMenuInsightDaily() : GetRichMenuInsightDailyResponse|ErrorResponse: Operation getRichMenuInsightDaily
getRichMenuInsightDailyAsync() : PromiseInterface: Operation getRichMenuInsightDailyAsync
getRichMenuInsightDailyAsyncWithHttpInfo() : PromiseInterface: Operation getRichMenuInsightDailyAsyncWithHttpInfo
getRichMenuInsightDailyRequest() : Request: Create request for operation 'getRichMenuInsightDaily'
getRichMenuInsightDailyWithHttpInfo() : array<string|int, mixed>: Operation getRichMenuInsightDailyWithHttpInfo
getRichMenuInsightSummary() : GetRichMenuInsightSummaryResponse|ErrorResponse: Operation getRichMenuInsightSummary
getRichMenuInsightSummaryAsync() : PromiseInterface: Operation getRichMenuInsightSummaryAsync
getRichMenuInsightSummaryAsyncWithHttpInfo() : PromiseInterface: Operation getRichMenuInsightSummaryAsyncWithHttpInfo
getRichMenuInsightSummaryRequest() : Request: Create request for operation 'getRichMenuInsightSummary'
getRichMenuInsightSummaryWithHttpInfo() : array<string|int, mixed>: Operation getRichMenuInsightSummaryWithHttpInfo
getStatisticsPerUnit() : GetStatisticsPerUnitResponse: Operation getStatisticsPerUnit
getStatisticsPerUnitAsync() : PromiseInterface: Operation getStatisticsPerUnitAsync
getStatisticsPerUnitAsyncWithHttpInfo() : PromiseInterface: Operation getStatisticsPerUnitAsyncWithHttpInfo
getStatisticsPerUnitRequest() : Request: Create request for operation 'getStatisticsPerUnit'
getStatisticsPerUnitWithHttpInfo() : array<string|int, mixed>: Operation getStatisticsPerUnitWithHttpInfo
setHostIndex() : void: Set the host index
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['getFriendsDemographics' => ['application/json'], 'getMessageEvent' => ['application/json'], 'getNumberOfFollowers' => ['application/json'], 'getNumberOfMessageDeliveries' => ['application/json'], 'getRichMenuInsightDaily' => ['application/json'], 'getRichMenuInsightSummary' => ['application/json'], 'getStatisticsPerUnit' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getFriendsDemographics()

Operation getFriendsDemographics


    public
                    getFriendsDemographics([string $contentType = self::contentTypes['getFriendsDemographics'][0] ]) : GetFriendsDemographicsResponse

Parameters

$contentType : string = self::contentTypes['getFriendsDemographics'][0]: The value for the Content-Type header. Check self::contentTypes['getFriendsDemographics'] to see the possible values for this operation

Return values

GetFriendsDemographicsResponse

getFriendsDemographicsAsync()

Operation getFriendsDemographicsAsync


    public
                    getFriendsDemographicsAsync([string $contentType = self::contentTypes['getFriendsDemographics'][0] ]) : PromiseInterface

Parameters

$contentType : string = self::contentTypes['getFriendsDemographics'][0]: The value for the Content-Type header. Check self::contentTypes['getFriendsDemographics'] to see the possible values for this operation

Return values

PromiseInterface

getFriendsDemographicsAsyncWithHttpInfo()

Operation getFriendsDemographicsAsyncWithHttpInfo


    public
                    getFriendsDemographicsAsyncWithHttpInfo([string $contentType = self::contentTypes['getFriendsDemographics'][0] ]) : PromiseInterface

Parameters

$contentType : string = self::contentTypes['getFriendsDemographics'][0]: The value for the Content-Type header. Check self::contentTypes['getFriendsDemographics'] to see the possible values for this operation

Return values

PromiseInterface

getFriendsDemographicsRequest()

Create request for operation 'getFriendsDemographics'


    public
                    getFriendsDemographicsRequest([string $contentType = self::contentTypes['getFriendsDemographics'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getFriendsDemographics'][0]: The value for the Content-Type header. Check self::contentTypes['getFriendsDemographics'] to see the possible values for this operation

Return values

Request

getFriendsDemographicsWithHttpInfo()

Operation getFriendsDemographicsWithHttpInfo


    public
                    getFriendsDemographicsWithHttpInfo([string $contentType = self::contentTypes['getFriendsDemographics'][0] ]) : array<string|int, mixed>

Parameters

$contentType : string = self::contentTypes['getFriendsDemographics'][0]: The value for the Content-Type header. Check self::contentTypes['getFriendsDemographics'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \LINE\Clients\Insight\Model\GetFriendsDemographicsResponse, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getMessageEvent()

Operation getMessageEvent


    public
                    getMessageEvent(string $requestId[, string $contentType = self::contentTypes['getMessageEvent'][0] ]) : GetMessageEventResponse

Get user interaction statistics

Parameters

$requestId : string: Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID. (required)
$contentType : string = self::contentTypes['getMessageEvent'][0]: The value for the Content-Type header. Check self::contentTypes['getMessageEvent'] to see the possible values for this operation

Return values

GetMessageEventResponse

getMessageEventAsync()

Operation getMessageEventAsync


    public
                    getMessageEventAsync(string $requestId[, string $contentType = self::contentTypes['getMessageEvent'][0] ]) : PromiseInterface

Get user interaction statistics

Parameters

$requestId : string: Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID. (required)
$contentType : string = self::contentTypes['getMessageEvent'][0]: The value for the Content-Type header. Check self::contentTypes['getMessageEvent'] to see the possible values for this operation

Return values

PromiseInterface

getMessageEventAsyncWithHttpInfo()

Operation getMessageEventAsyncWithHttpInfo


    public
                    getMessageEventAsyncWithHttpInfo(string $requestId[, string $contentType = self::contentTypes['getMessageEvent'][0] ]) : PromiseInterface

Get user interaction statistics

Parameters

$requestId : string: Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID. (required)
$contentType : string = self::contentTypes['getMessageEvent'][0]: The value for the Content-Type header. Check self::contentTypes['getMessageEvent'] to see the possible values for this operation

Return values

PromiseInterface

getMessageEventRequest()

Create request for operation 'getMessageEvent'


    public
                    getMessageEventRequest(string $requestId[, string $contentType = self::contentTypes['getMessageEvent'][0] ]) : Request

Parameters

$requestId : string: Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID. (required)
$contentType : string = self::contentTypes['getMessageEvent'][0]: The value for the Content-Type header. Check self::contentTypes['getMessageEvent'] to see the possible values for this operation

Return values

Request

getMessageEventWithHttpInfo()

Operation getMessageEventWithHttpInfo


    public
                    getMessageEventWithHttpInfo(string $requestId[, string $contentType = self::contentTypes['getMessageEvent'][0] ]) : array<string|int, mixed>

Get user interaction statistics

Parameters

$requestId : string: Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID. (required)
$contentType : string = self::contentTypes['getMessageEvent'][0]: The value for the Content-Type header. Check self::contentTypes['getMessageEvent'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \LINE\Clients\Insight\Model\GetMessageEventResponse, HTTP status code, HTTP response headers (array of strings)

getNumberOfFollowers()

Operation getNumberOfFollowers


    public
                    getNumberOfFollowers([string|null $date = null ][, string $contentType = self::contentTypes['getNumberOfFollowers'][0] ]) : GetNumberOfFollowersResponse

Get number of followers

Parameters

$date : string|null = null: Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 (optional)
$contentType : string = self::contentTypes['getNumberOfFollowers'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfFollowers'] to see the possible values for this operation

Return values

GetNumberOfFollowersResponse

getNumberOfFollowersAsync()

Operation getNumberOfFollowersAsync


    public
                    getNumberOfFollowersAsync([string|null $date = null ][, string $contentType = self::contentTypes['getNumberOfFollowers'][0] ]) : PromiseInterface

Get number of followers

Parameters

$date : string|null = null: Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 (optional)
$contentType : string = self::contentTypes['getNumberOfFollowers'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfFollowers'] to see the possible values for this operation

Return values

PromiseInterface

getNumberOfFollowersAsyncWithHttpInfo()

Operation getNumberOfFollowersAsyncWithHttpInfo


    public
                    getNumberOfFollowersAsyncWithHttpInfo([string|null $date = null ][, string $contentType = self::contentTypes['getNumberOfFollowers'][0] ]) : PromiseInterface

Get number of followers

Parameters

$date : string|null = null: Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 (optional)
$contentType : string = self::contentTypes['getNumberOfFollowers'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfFollowers'] to see the possible values for this operation

Return values

PromiseInterface

getNumberOfFollowersRequest()

Create request for operation 'getNumberOfFollowers'


    public
                    getNumberOfFollowersRequest([string|null $date = null ][, string $contentType = self::contentTypes['getNumberOfFollowers'][0] ]) : Request

Parameters

$date : string|null = null: Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 (optional)
$contentType : string = self::contentTypes['getNumberOfFollowers'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfFollowers'] to see the possible values for this operation

Return values

Request

getNumberOfFollowersWithHttpInfo()

Operation getNumberOfFollowersWithHttpInfo


    public
                    getNumberOfFollowersWithHttpInfo([string|null $date = null ][, string $contentType = self::contentTypes['getNumberOfFollowers'][0] ]) : array<string|int, mixed>

Get number of followers

Parameters

$date : string|null = null: Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 (optional)
$contentType : string = self::contentTypes['getNumberOfFollowers'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfFollowers'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \LINE\Clients\Insight\Model\GetNumberOfFollowersResponse, HTTP status code, HTTP response headers (array of strings)

getNumberOfMessageDeliveries()

Operation getNumberOfMessageDeliveries


    public
                    getNumberOfMessageDeliveries(string $date[, string $contentType = self::contentTypes['getNumberOfMessageDeliveries'][0] ]) : GetNumberOfMessageDeliveriesResponse

Get number of message deliveries

Parameters

$date : string: Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9 (required)
$contentType : string = self::contentTypes['getNumberOfMessageDeliveries'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfMessageDeliveries'] to see the possible values for this operation

Return values

GetNumberOfMessageDeliveriesResponse

getNumberOfMessageDeliveriesAsync()

Operation getNumberOfMessageDeliveriesAsync


    public
                    getNumberOfMessageDeliveriesAsync(string $date[, string $contentType = self::contentTypes['getNumberOfMessageDeliveries'][0] ]) : PromiseInterface

Get number of message deliveries

Parameters

$date : string: Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9 (required)
$contentType : string = self::contentTypes['getNumberOfMessageDeliveries'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfMessageDeliveries'] to see the possible values for this operation

Return values

PromiseInterface

getNumberOfMessageDeliveriesAsyncWithHttpInfo()

Operation getNumberOfMessageDeliveriesAsyncWithHttpInfo


    public
                    getNumberOfMessageDeliveriesAsyncWithHttpInfo(string $date[, string $contentType = self::contentTypes['getNumberOfMessageDeliveries'][0] ]) : PromiseInterface

Get number of message deliveries

Parameters

$date : string: Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9 (required)
$contentType : string = self::contentTypes['getNumberOfMessageDeliveries'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfMessageDeliveries'] to see the possible values for this operation

Return values

PromiseInterface

getNumberOfMessageDeliveriesRequest()

Create request for operation 'getNumberOfMessageDeliveries'


    public
                    getNumberOfMessageDeliveriesRequest(string $date[, string $contentType = self::contentTypes['getNumberOfMessageDeliveries'][0] ]) : Request

Parameters

$date : string: Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9 (required)
$contentType : string = self::contentTypes['getNumberOfMessageDeliveries'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfMessageDeliveries'] to see the possible values for this operation

Return values

Request

getNumberOfMessageDeliveriesWithHttpInfo()

Operation getNumberOfMessageDeliveriesWithHttpInfo


    public
                    getNumberOfMessageDeliveriesWithHttpInfo(string $date[, string $contentType = self::contentTypes['getNumberOfMessageDeliveries'][0] ]) : array<string|int, mixed>

Get number of message deliveries

Parameters

$date : string: Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9 (required)
$contentType : string = self::contentTypes['getNumberOfMessageDeliveries'][0]: The value for the Content-Type header. Check self::contentTypes['getNumberOfMessageDeliveries'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \LINE\Clients\Insight\Model\GetNumberOfMessageDeliveriesResponse, HTTP status code, HTTP response headers (array of strings)

getRichMenuInsightDaily()

Operation getRichMenuInsightDaily


    public
                    getRichMenuInsightDaily(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightDaily'][0] ]) : GetRichMenuInsightDailyResponse|ErrorResponse

Get rich menu insight daily

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightDaily'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightDaily'] to see the possible values for this operation

Return values

GetRichMenuInsightDailyResponse|ErrorResponse

getRichMenuInsightDailyAsync()

Operation getRichMenuInsightDailyAsync


    public
                    getRichMenuInsightDailyAsync(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightDaily'][0] ]) : PromiseInterface

Get rich menu insight daily

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightDaily'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightDaily'] to see the possible values for this operation

Return values

PromiseInterface

getRichMenuInsightDailyAsyncWithHttpInfo()

Operation getRichMenuInsightDailyAsyncWithHttpInfo


    public
                    getRichMenuInsightDailyAsyncWithHttpInfo(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightDaily'][0] ]) : PromiseInterface

Get rich menu insight daily

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightDaily'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightDaily'] to see the possible values for this operation

Return values

PromiseInterface

getRichMenuInsightDailyRequest()

Create request for operation 'getRichMenuInsightDaily'


    public
                    getRichMenuInsightDailyRequest(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightDaily'][0] ]) : Request

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightDaily'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightDaily'] to see the possible values for this operation

Return values

Request

getRichMenuInsightDailyWithHttpInfo()

Operation getRichMenuInsightDailyWithHttpInfo


    public
                    getRichMenuInsightDailyWithHttpInfo(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightDaily'][0] ]) : array<string|int, mixed>

Get rich menu insight daily

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightDaily'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightDaily'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \LINE\Clients\Insight\Model\GetRichMenuInsightDailyResponse|\LINE\Clients\Insight\Model\ErrorResponse|\LINE\Clients\Insight\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getRichMenuInsightSummary()

Operation getRichMenuInsightSummary


    public
                    getRichMenuInsightSummary(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightSummary'][0] ]) : GetRichMenuInsightSummaryResponse|ErrorResponse

Get rich menu insight summary

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightSummary'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightSummary'] to see the possible values for this operation

Return values

GetRichMenuInsightSummaryResponse|ErrorResponse

getRichMenuInsightSummaryAsync()

Operation getRichMenuInsightSummaryAsync


    public
                    getRichMenuInsightSummaryAsync(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightSummary'][0] ]) : PromiseInterface

Get rich menu insight summary

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightSummary'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightSummary'] to see the possible values for this operation

Return values

PromiseInterface

getRichMenuInsightSummaryAsyncWithHttpInfo()

Operation getRichMenuInsightSummaryAsyncWithHttpInfo


    public
                    getRichMenuInsightSummaryAsyncWithHttpInfo(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightSummary'][0] ]) : PromiseInterface

Get rich menu insight summary

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightSummary'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightSummary'] to see the possible values for this operation

Return values

PromiseInterface

getRichMenuInsightSummaryRequest()

Create request for operation 'getRichMenuInsightSummary'


    public
                    getRichMenuInsightSummaryRequest(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightSummary'][0] ]) : Request

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightSummary'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightSummary'] to see the possible values for this operation

Return values

Request

getRichMenuInsightSummaryWithHttpInfo()

Operation getRichMenuInsightSummaryWithHttpInfo


    public
                    getRichMenuInsightSummaryWithHttpInfo(string $richMenuId, string $from, string $to[, string $contentType = self::contentTypes['getRichMenuInsightSummary'][0] ]) : array<string|int, mixed>

Get rich menu insight summary

Parameters

$richMenuId : string: ID of the rich menu created via the Messaging API. (required)
$from : string: Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9 (required)
$to : string: End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getRichMenuInsightSummary'][0]: The value for the Content-Type header. Check self::contentTypes['getRichMenuInsightSummary'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \LINE\Clients\Insight\Model\GetRichMenuInsightSummaryResponse|\LINE\Clients\Insight\Model\ErrorResponse|\LINE\Clients\Insight\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getStatisticsPerUnit()

Operation getStatisticsPerUnit


    public
                    getStatisticsPerUnit(string $customAggregationUnit, string $from, string $to[, string $contentType = self::contentTypes['getStatisticsPerUnit'][0] ]) : GetStatisticsPerUnitResponse

Parameters

$customAggregationUnit : string: Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names. (required)
$from : string: Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$to : string: End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getStatisticsPerUnit'][0]: The value for the Content-Type header. Check self::contentTypes['getStatisticsPerUnit'] to see the possible values for this operation

Return values

GetStatisticsPerUnitResponse

getStatisticsPerUnitAsync()

Operation getStatisticsPerUnitAsync


    public
                    getStatisticsPerUnitAsync(string $customAggregationUnit, string $from, string $to[, string $contentType = self::contentTypes['getStatisticsPerUnit'][0] ]) : PromiseInterface

Parameters

$customAggregationUnit : string: Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names. (required)
$from : string: Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$to : string: End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getStatisticsPerUnit'][0]: The value for the Content-Type header. Check self::contentTypes['getStatisticsPerUnit'] to see the possible values for this operation

Return values

PromiseInterface

getStatisticsPerUnitAsyncWithHttpInfo()

Operation getStatisticsPerUnitAsyncWithHttpInfo


    public
                    getStatisticsPerUnitAsyncWithHttpInfo(string $customAggregationUnit, string $from, string $to[, string $contentType = self::contentTypes['getStatisticsPerUnit'][0] ]) : PromiseInterface

Parameters

$customAggregationUnit : string: Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names. (required)
$from : string: Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$to : string: End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getStatisticsPerUnit'][0]: The value for the Content-Type header. Check self::contentTypes['getStatisticsPerUnit'] to see the possible values for this operation

Return values

PromiseInterface

getStatisticsPerUnitRequest()

Create request for operation 'getStatisticsPerUnit'


    public
                    getStatisticsPerUnitRequest(string $customAggregationUnit, string $from, string $to[, string $contentType = self::contentTypes['getStatisticsPerUnit'][0] ]) : Request

Parameters

$customAggregationUnit : string: Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names. (required)
$from : string: Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$to : string: End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getStatisticsPerUnit'][0]: The value for the Content-Type header. Check self::contentTypes['getStatisticsPerUnit'] to see the possible values for this operation

Return values

Request

getStatisticsPerUnitWithHttpInfo()

Operation getStatisticsPerUnitWithHttpInfo


    public
                    getStatisticsPerUnitWithHttpInfo(string $customAggregationUnit, string $from, string $to[, string $contentType = self::contentTypes['getStatisticsPerUnit'][0] ]) : array<string|int, mixed>

Parameters

$customAggregationUnit : string: Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names. (required)
$from : string: Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$to : string: End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9 (required)
$contentType : string = self::contentTypes['getStatisticsPerUnit'][0]: The value for the Content-Type header. Check self::contentTypes['getStatisticsPerUnit'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \LINE\Clients\Insight\Model\GetStatisticsPerUnitResponse, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

InsightApi in package LINE Clients Insight

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

getConfig()

Return values

getFriendsDemographics()

Parameters

Tags

Return values

getFriendsDemographicsAsync()

Parameters

Tags

Return values

getFriendsDemographicsAsyncWithHttpInfo()

Parameters

Tags

Return values

getFriendsDemographicsRequest()

Parameters

Tags

Return values

getFriendsDemographicsWithHttpInfo()

Parameters

Tags

Return values

getHostIndex()

Return values

getMessageEvent()

Parameters

Tags

Return values

getMessageEventAsync()

Parameters

Tags

Return values

getMessageEventAsyncWithHttpInfo()

Parameters

Tags

Return values

getMessageEventRequest()

Parameters

Tags

Return values

getMessageEventWithHttpInfo()

Parameters

Tags

Return values

getNumberOfFollowers()

Parameters

Tags

Return values

getNumberOfFollowersAsync()

Parameters

Tags

Return values

getNumberOfFollowersAsyncWithHttpInfo()

Parameters

Tags

Return values

getNumberOfFollowersRequest()

Parameters

Tags

Return values

getNumberOfFollowersWithHttpInfo()

Parameters

Tags

Return values

InsightApi
in package

LINE

Clients

Insight