llmpulse-java

LLM Pulse API

API version: 1.22.0
Generator version: 7.24.0

REST API client for LLM Pulse AI visibility analytics.

For more information, please visit https://llmpulse.ai

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

Java 11+
Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>ai.llmpulse</groupId>
  <artifactId>llmpulse-java</artifactId>
  <version>1.22.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "ai.llmpulse:llmpulse-java:1.22.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

target/llmpulse-java-1.22.0.jar
target/lib/*.jar

Getting Started

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

import ai.llmpulse.sdk.*;
import ai.llmpulse.sdk.model.*;
import ai.llmpulse.sdk.api.AiModelInsightsApi;

public class AiModelInsightsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure clients using the `defaultClient` object, such as
        // overriding the host and port, timeout, etc.
        AiModelInsightsApi apiInstance = new AiModelInsightsApi(defaultClient);
        Integer projectId = 56; // Integer | Project ID
        Integer range = 56; // Integer | Number of days to look back (alternative to from/to)
        OffsetDateTime from = OffsetDateTime.now(); // OffsetDateTime | 
        OffsetDateTime to = OffsetDateTime.now(); // OffsetDateTime | 
        String granularity = "day"; // String | 
        Integer collectionId = 56; // Integer | 
        String countryCode = "countryCode_example"; // String | ISO country code (e.g. US, GB, DE)
        String languageCode = "languageCode_example"; // String | ISO language code (e.g. en, es, de)
        String promptType = "informational"; // String | Filter by prompt type (search intent)
        String brandKind = "brand"; // String | Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
        String competitors = "competitors_example"; // String | Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
        try {
            apiInstance.getAiModelInsightsSummary(projectId, range, from, to, granularity, collectionId, countryCode, languageCode, promptType, brandKind, competitors);
        } catch (ApiException e) {
            System.err.println("Exception when calling AiModelInsightsApi#getAiModelInsightsSummary");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.llmpulse.ai/api/v1

Class	Method	HTTP request	Description
AiModelInsightsApi	getAiModelInsightsSummary	GET /reports/ai_model_insights/summary	AI Model Insights summary
AiModelInsightsApi	getAiModelInsightsSummaryWithHttpInfo	GET /reports/ai_model_insights/summary	AI Model Insights summary
AiModelInsightsApi	getAiModelPositionDistribution	GET /reports/ai_model_insights/position_distribution	Position distribution comparison
AiModelInsightsApi	getAiModelPositionDistributionWithHttpInfo	GET /reports/ai_model_insights/position_distribution	Position distribution comparison
AiModelInsightsApi	getAiOverviewResults	GET /reports/ai_model_insights/ai_overview_results	Google AI Overview result availability
AiModelInsightsApi	getAiOverviewResultsWithHttpInfo	GET /reports/ai_model_insights/ai_overview_results	Google AI Overview result availability
AnnotationsApi	createAnnotation	POST /annotations	Create a timeline annotation
AnnotationsApi	createAnnotationWithHttpInfo	POST /annotations	Create a timeline annotation
AnnotationsApi	deleteAnnotation	DELETE /annotations/{id}	Delete a timeline annotation
AnnotationsApi	deleteAnnotationWithHttpInfo	DELETE /annotations/{id}	Delete a timeline annotation
AnnotationsApi	listAnnotations	GET /annotations	List timeline annotations
AnnotationsApi	listAnnotationsWithHttpInfo	GET /annotations	List timeline annotations
AnnotationsApi	updateAnnotation	PATCH /annotations/{id}	Update a timeline annotation
AnnotationsApi	updateAnnotationWithHttpInfo	PATCH /annotations/{id}	Update a timeline annotation
AnswersApi	getAnswer	GET /answers/{id}	Get one AI response
AnswersApi	getAnswerWithHttpInfo	GET /answers/{id}	Get one AI response
AnswersApi	listAnswers	GET /answers	List AI responses
AnswersApi	listAnswersWithHttpInfo	GET /answers	List AI responses
CitationIntelligenceApi	getCitedUrlContent	GET /citation_intelligence/urls/{url_sha256}/content	Cited URL cached content
CitationIntelligenceApi	getCitedUrlContentWithHttpInfo	GET /citation_intelligence/urls/{url_sha256}/content	Cited URL cached content
CitationIntelligenceApi	getCitedUrlDetail	GET /citation_intelligence/urls/{url_sha256}	Cited URL detail
CitationIntelligenceApi	getCitedUrlDetailWithHttpInfo	GET /citation_intelligence/urls/{url_sha256}	Cited URL detail
CitationIntelligenceApi	getMentionsByCitingDomain	GET /citation_intelligence/mentions_by_domain	Mention share by citing domain
CitationIntelligenceApi	getMentionsByCitingDomainWithHttpInfo	GET /citation_intelligence/mentions_by_domain	Mention share by citing domain
CitationIntelligenceApi	listCitationGroups	GET /citation_intelligence/groups	Grouped citation intelligence
CitationIntelligenceApi	listCitationGroupsWithHttpInfo	GET /citation_intelligence/groups	Grouped citation intelligence
CitationIntelligenceApi	listCitedUrlOccurrences	GET /citation_intelligence/urls/{url_sha256}/occurrences	Cited URL occurrences
CitationIntelligenceApi	listCitedUrlOccurrencesWithHttpInfo	GET /citation_intelligence/urls/{url_sha256}/occurrences	Cited URL occurrences
CollectionsApi	createCollection	POST /collections	Create a tag
CollectionsApi	createCollectionWithHttpInfo	POST /collections	Create a tag
CollectionsApi	deleteCollection	DELETE /collections/{id}	Delete a tag
CollectionsApi	deleteCollectionWithHttpInfo	DELETE /collections/{id}	Delete a tag
CollectionsApi	updateCollection	PATCH /collections/{id}	Update a tag
CollectionsApi	updateCollectionWithHttpInfo	PATCH /collections/{id}	Update a tag
CompetitorsApi	createCompetitor	POST /competitors	Add a competitor
CompetitorsApi	createCompetitorWithHttpInfo	POST /competitors	Add a competitor
CompetitorsApi	deleteCompetitor	DELETE /competitors/{id}	Delete a competitor
CompetitorsApi	deleteCompetitorWithHttpInfo	DELETE /competitors/{id}	Delete a competitor
CompetitorsApi	updateCompetitor	PATCH /competitors/{id}	Update a competitor
CompetitorsApi	updateCompetitorWithHttpInfo	PATCH /competitors/{id}	Update a competitor
DimensionsApi	getCompetitorDetails	GET /dimensions/competitors/{id}	Competitor details
DimensionsApi	getCompetitorDetailsWithHttpInfo	GET /dimensions/competitors/{id}	Competitor details
DimensionsApi	getProjectDetails	GET /dimensions/projects/{id}	Project details
DimensionsApi	getProjectDetailsWithHttpInfo	GET /dimensions/projects/{id}	Project details
DimensionsApi	listAgentBots	GET /dimensions/agent_bots	AI bot catalog (Scale+)
DimensionsApi	listAgentBotsWithHttpInfo	GET /dimensions/agent_bots	AI bot catalog (Scale+)
DimensionsApi	listAllCitations	GET /dimensions/all_citations	List all citations (brand + competitor)
DimensionsApi	listAllCitationsWithHttpInfo	GET /dimensions/all_citations	List all citations (brand + competitor)
DimensionsApi	listAllMentions	GET /dimensions/all_mentions	List all mentions (brand + competitor)
DimensionsApi	listAllMentionsWithHttpInfo	GET /dimensions/all_mentions	List all mentions (brand + competitor)
DimensionsApi	listCitations	GET /dimensions/citations	List brand citations
DimensionsApi	listCitationsWithHttpInfo	GET /dimensions/citations	List brand citations
DimensionsApi	listCollections	GET /dimensions/collections	List tags/collections
DimensionsApi	listCollectionsWithHttpInfo	GET /dimensions/collections	List tags/collections
DimensionsApi	listCompetitorCitations	GET /dimensions/competitor_citations	List competitor citations
DimensionsApi	listCompetitorCitationsWithHttpInfo	GET /dimensions/competitor_citations	List competitor citations
DimensionsApi	listCompetitorMentions	GET /dimensions/competitor_mentions	List competitor mentions
DimensionsApi	listCompetitorMentionsWithHttpInfo	GET /dimensions/competitor_mentions	List competitor mentions
DimensionsApi	listCompetitors	GET /dimensions/competitors	List competitors
DimensionsApi	listCompetitorsWithHttpInfo	GET /dimensions/competitors	List competitors
DimensionsApi	listLocales	GET /dimensions/locales	List locales with data
DimensionsApi	listLocalesWithHttpInfo	GET /dimensions/locales	List locales with data
DimensionsApi	listMentions	GET /dimensions/mentions	List brand mentions
DimensionsApi	listMentionsWithHttpInfo	GET /dimensions/mentions	List brand mentions
DimensionsApi	listModels	GET /dimensions/models	List models with data
DimensionsApi	listModelsWithHttpInfo	GET /dimensions/models	List models with data
DimensionsApi	listProjects	GET /dimensions/projects	List projects
DimensionsApi	listProjectsWithHttpInfo	GET /dimensions/projects	List projects
DimensionsApi	listPromptExecutions	GET /dimensions/prompt_executions	List prompt executions
DimensionsApi	listPromptExecutionsWithHttpInfo	GET /dimensions/prompt_executions	List prompt executions
DimensionsApi	listPrompts	GET /dimensions/prompts	List prompts
DimensionsApi	listPromptsWithHttpInfo	GET /dimensions/prompts	List prompts
DimensionsApi	listSentimentCategories	GET /dimensions/sentiments	List sentiment categories
DimensionsApi	listSentimentCategoriesWithHttpInfo	GET /dimensions/sentiments	List sentiment categories
DimensionsApi	listSources	GET /dimensions/sources	List source URLs
DimensionsApi	listSourcesWithHttpInfo	GET /dimensions/sources	List source URLs
DimensionsApi	listTags	GET /dimensions/tags	List tags (alias for /collections)
DimensionsApi	listTagsWithHttpInfo	GET /dimensions/tags	List tags (alias for /collections)
GeoWriterApi	createIntelligenceTask	POST /intelligence_tasks	Create a GEO Writer task
GeoWriterApi	createIntelligenceTaskWithHttpInfo	POST /intelligence_tasks	Create a GEO Writer task
GeoWriterApi	getIntelligenceTask	GET /intelligence_tasks/{id}	Get a GEO Writer task
GeoWriterApi	getIntelligenceTaskWithHttpInfo	GET /intelligence_tasks/{id}	Get a GEO Writer task
GeoWriterApi	listIntelligenceTasks	GET /intelligence_tasks	List GEO Writer tasks
GeoWriterApi	listIntelligenceTasksWithHttpInfo	GET /intelligence_tasks	List GEO Writer tasks
HealthApi	ping	GET /ping	Health check
HealthApi	pingWithHttpInfo	GET /ping	Health check
MetricsApi	getAgentTraffic	GET /metrics/agent_traffic	AI bot crawler traffic (Scale+, Beta)
MetricsApi	getAgentTrafficWithHttpInfo	GET /metrics/agent_traffic	AI bot crawler traffic (Scale+, Beta)
MetricsApi	getAiTraffic	GET /metrics/ai_traffic	AI referral traffic (Scale+)
MetricsApi	getAiTrafficWithHttpInfo	GET /metrics/ai_traffic	AI referral traffic (Scale+)
MetricsApi	getPromptSummary	GET /metrics/prompt_summary	Per-prompt metrics summary
MetricsApi	getPromptSummaryWithHttpInfo	GET /metrics/prompt_summary	Per-prompt metrics summary
MetricsApi	getShareOfVoice	GET /metrics/sov	Share of Voice
MetricsApi	getShareOfVoiceWithHttpInfo	GET /metrics/sov	Share of Voice
MetricsApi	getSummary	GET /metrics/summary	Aggregated metrics summary
MetricsApi	getSummaryWithHttpInfo	GET /metrics/summary	Aggregated metrics summary
MetricsApi	getTimeseries	GET /metrics/timeseries	Time-series metrics
MetricsApi	getTimeseriesWithHttpInfo	GET /metrics/timeseries	Time-series metrics
MetricsApi	getTopSources	GET /metrics/top_sources	Top cited sources
MetricsApi	getTopSourcesWithHttpInfo	GET /metrics/top_sources	Top cited sources
ProjectsApi	createProject	POST /projects	Create a project (fast mode)
ProjectsApi	createProjectWithHttpInfo	POST /projects	Create a project (fast mode)
ProjectsApi	createProjectDraft	POST /project_drafts	Start a project draft (wizard step 1)
ProjectsApi	createProjectDraftWithHttpInfo	POST /project_drafts	Start a project draft (wizard step 1)
ProjectsApi	finalizeProjectDraft	POST /project_drafts/{id}/finalize	Finalize a draft into a real project
ProjectsApi	finalizeProjectDraftWithHttpInfo	POST /project_drafts/{id}/finalize	Finalize a draft into a real project
ProjectsApi	getProjectDraft	GET /project_drafts/{id}	Read a project draft
ProjectsApi	getProjectDraftWithHttpInfo	GET /project_drafts/{id}	Read a project draft
ProjectsApi	updateProjectDraft	PATCH /project_drafts/{id}	Submit a wizard step
ProjectsApi	updateProjectDraftWithHttpInfo	PATCH /project_drafts/{id}	Submit a wizard step
PromptsApi	assignPromptTags	POST /prompts/assign_tags	Bulk-attach tags to prompts
PromptsApi	assignPromptTagsWithHttpInfo	POST /prompts/assign_tags	Bulk-attach tags to prompts
PromptsApi	createPrompts	POST /prompts	Bulk-create prompts
PromptsApi	createPromptsWithHttpInfo	POST /prompts	Bulk-create prompts
PromptsApi	deletePrompt	DELETE /prompts/{id}	Delete a prompt
PromptsApi	deletePromptWithHttpInfo	DELETE /prompts/{id}	Delete a prompt
RecommendationsApi	getRecommendation	GET /recommendations/{id}	Get recommendation run with items
RecommendationsApi	getRecommendationWithHttpInfo	GET /recommendations/{id}	Get recommendation run with items
RecommendationsApi	launchRecommendations	POST /recommendations	Launch a recommendations generation
RecommendationsApi	launchRecommendationsWithHttpInfo	POST /recommendations	Launch a recommendations generation
RecommendationsApi	listRecommendations	GET /recommendations	List recommendation runs
RecommendationsApi	listRecommendationsWithHttpInfo	GET /recommendations	List recommendation runs
ReportsApi	createTechnicalGeoReports	POST /technical_geo_reports	Run technical GEO analysis
ReportsApi	createTechnicalGeoReportsWithHttpInfo	POST /technical_geo_reports	Run technical GEO analysis
SearchConsoleApi	getSearchConsolePages	GET /search_console/pages	Top Search Console pages (Growth+)
SearchConsoleApi	getSearchConsolePagesWithHttpInfo	GET /search_console/pages	Top Search Console pages (Growth+)
SearchConsoleApi	getSearchConsoleQueries	GET /search_console/queries	Top Search Console queries (Growth+)
SearchConsoleApi	getSearchConsoleQueriesWithHttpInfo	GET /search_console/queries	Top Search Console queries (Growth+)
SearchConsoleApi	getSearchConsoleSummary	GET /search_console/summary	Search Console summary (Growth+)
SearchConsoleApi	getSearchConsoleSummaryWithHttpInfo	GET /search_console/summary	Search Console summary (Growth+)
SearchConsoleApi	getSearchConsoleTimeseries	GET /search_console/timeseries	Search Console time series (Growth+)
SearchConsoleApi	getSearchConsoleTimeseriesWithHttpInfo	GET /search_console/timeseries	Search Console time series (Growth+)
SentimentsApi	listSentimentRecords	GET /sentiments	List sentiment records
SentimentsApi	listSentimentRecordsWithHttpInfo	GET /sentiments	List sentiment records
WebhooksApi	createWebhook	POST /webhooks	Create a webhook subscription
WebhooksApi	createWebhookWithHttpInfo	POST /webhooks	Create a webhook subscription
WebhooksApi	deleteWebhook	DELETE /webhooks/{id}	Delete a webhook subscription
WebhooksApi	deleteWebhookWithHttpInfo	DELETE /webhooks/{id}	Delete a webhook subscription
WebhooksApi	listWebhooks	GET /webhooks	List webhook subscriptions
WebhooksApi	listWebhooksWithHttpInfo	GET /webhooks	List webhook subscriptions
WebhooksApi	sampleWebhookPayloads	GET /webhooks/sample/{event_type}	Sample event payloads
WebhooksApi	sampleWebhookPayloadsWithHttpInfo	GET /webhooks/sample/{event_type}	Sample event payloads

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

Type: HTTP Bearer Token authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.

Author

info@llmpulse.ai

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
.openapi-generator		.openapi-generator
api		api
docs		docs
gradle/wrapper		gradle/wrapper
src/main		src/main
.gitignore		.gitignore
.openapi-generator-ignore		.openapi-generator-ignore
.travis.yml		.travis.yml
LICENSE		LICENSE
README.md		README.md
build.gradle		build.gradle
build.sbt		build.sbt
git_push.sh		git_push.sh
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
pom.xml		pom.xml
settings.gradle		settings.gradle

Navigation Menu

Uh oh!

Repository files navigation

llmpulse-java

Requirements

Installation

Maven users

Gradle users

Others

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

BearerAuth

Recommendation

Author

About

Releases

Packages

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

llmpulse-java

Requirements

Installation

Maven users

Gradle users

Others

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

BearerAuth

Recommendation

Author

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages