insights.md

Insights

1 operation(s). Part of the API index.

Call these as $client-><service>-><method>(...). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

---

queryUserProfilesInsights

POST /insights/userprofiles

Retrieve User's data by filters

Retrieves users based on specified query parameters.

Example

function callQueryUserProfilesInsights($client) {
    $requestPayload = new \LoginRadius\Sdk\Internal\OpenApi\Model\RequestPayload(['from' => '<from>', 'to' => '<to>', 'q' => '<q>']); //Required
    $region = '<region>'; //Optional

    try {
        $response = $client->insights->queryUserProfilesInsights($requestPayload, region: $region);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
region	query	string	no	The region to filter results by.

Request body

requestPayload as application/json.

Returns

InsightsResponse