{"id":20916222,"url":"https://github.com/qualityunit/urlslab-php-client","last_synced_at":"2025-03-12T23:21:57.645Z","repository":{"id":131207647,"uuid":"611131531","full_name":"QualityUnit/urlslab-php-client","owner":"QualityUnit","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-13T06:50:20.000Z","size":593,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-20T07:11:17.572Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QualityUnit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-08T07:16:35.000Z","updated_at":"2024-11-07T02:22:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"7acd3551-be2f-4006-9c15-a4e807e0b9f5","html_url":"https://github.com/QualityUnit/urlslab-php-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Furlslab-php-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Furlslab-php-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Furlslab-php-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2Furlslab-php-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QualityUnit","download_url":"https://codeload.github.com/QualityUnit/urlslab-php-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243308600,"owners_count":20270448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-18T16:20:38.685Z","updated_at":"2025-03-12T23:21:57.610Z","avatar_url":"https://github.com/QualityUnit.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPIClient-php\n\noptimize your website with SEO\n\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 7.4 and later.\nShould also work with PHP 8.0.\n\n### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/urlslab/urlslab-php-sdk.git\"\n    }\n  ],\n  \"require\": {\n    \"urlslab/urlslab-php-sdk\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n\u003c?php\nrequire_once('/path/to/OpenAPIClient-php/vendor/autoload.php');\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n\n// Configure API key authorization: UrlslabApiKeyAuth\n$config = OpenAPI\\Client\\Configuration::getDefaultConfiguration()-\u003esetApiKey('X-URLSLAB-KEY', 'YOUR_API_KEY');\n// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n// $config = OpenAPI\\Client\\Configuration::getDefaultConfiguration()-\u003esetApiKeyPrefix('X-URLSLAB-KEY', 'Bearer');\n\n\n$apiInstance = new OpenAPI\\Client\\Api\\AnalyticsApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$domain_data_retrieval_analytics_search_request = new \\OpenAPI\\Client\\Model\\DomainDataRetrievalAnalyticsSearchRequest(); // \\OpenAPI\\Client\\Model\\DomainDataRetrievalAnalyticsSearchRequest | Analytics request\n\ntry {\n    $result = $apiInstance-\u003egetPageStats($domain_data_retrieval_analytics_search_request);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling AnalyticsApi-\u003egetPageStats: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n```\n\n## API Endpoints\n\nAll URIs are relative to *https://api.urlslab.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AnalyticsApi* | [**getPageStats**](docs/Api/AnalyticsApi.md#getpagestats) | **POST** /v1/analytics/page-stats | Page Stats data from google search console\n*AnalyticsApi* | [**getSiteUrls**](docs/Api/AnalyticsApi.md#getsiteurls) | **GET** /v1/analytics/site-urls | Site URLs from GSC\n*AnalyticsApi* | [**getTopKeywords**](docs/Api/AnalyticsApi.md#gettopkeywords) | **POST** /v1/analytics/keywords | Keyword Analytics data from google search console\n*ApikeyApi* | [**validate**](docs/Api/ApikeyApi.md#validate) | **GET** /v1/apikey/validate | validate a given API Key\n*AuthApi* | [**getAuthIntegrations**](docs/Api/AuthApi.md#getauthintegrations) | **GET** /v1/auth/integrations | check if the user is already integrated to a specific integration\n*AuthApi* | [**getUserInfo**](docs/Api/AuthApi.md#getuserinfo) | **GET** /v1/auth/user-info | get user info\n*AuthApi* | [**getUserSubscriptionDetail**](docs/Api/AuthApi.md#getusersubscriptiondetail) | **GET** /v1/auth/user-sub | get user subscription Detail\n*AuthApi* | [**logout**](docs/Api/AuthApi.md#logout) | **POST** /v1/auth/signout | logout for users\n*AuthApi* | [**signin**](docs/Api/AuthApi.md#signin) | **GET** /v1/auth/signin/{provider} | login for users\n*ChatbotApi* | [**createChatbot**](docs/Api/ChatbotApi.md#createchatbot) | **PUT** /v1/chatbots | Create chatbot\n*ChatbotApi* | [**createChatbotSession**](docs/Api/ChatbotApi.md#createchatbotsession) | **PUT** /v1/chatbots/sessions/{userChatbotId} | Create chatbot session\n*ChatbotApi* | [**deleteChatbot**](docs/Api/ChatbotApi.md#deletechatbot) | **DELETE** /v1/chatbots/{id} | Delete chatbot\n*ChatbotApi* | [**deleteChatbotSession**](docs/Api/ChatbotApi.md#deletechatbotsession) | **DELETE** /v1/chatbots/sessions/{chatbotId}/{sessionId} | Delete chatbot session\n*ChatbotApi* | [**getChatbot**](docs/Api/ChatbotApi.md#getchatbot) | **GET** /v1/chatbots/{id} | Get chatbot by id\n*ChatbotApi* | [**getChatbotSessionConversation**](docs/Api/ChatbotApi.md#getchatbotsessionconversation) | **GET** /v1/chatbots/conversations/sessions/{chatbotId}/{sessionId} | Get chatbot conversation\n*ChatbotApi* | [**getChatbotSessionSources**](docs/Api/ChatbotApi.md#getchatbotsessionsources) | **GET** /v1/chatbots/sessions/{chatbotId}/{sessionId}/sources | Get chatbot session sources\n*ChatbotApi* | [**getChatbotSessions**](docs/Api/ChatbotApi.md#getchatbotsessions) | **GET** /v1/chatbots/conversations/ | Get chatbot sessions\n*ChatbotApi* | [**getChatbotSessionsChart**](docs/Api/ChatbotApi.md#getchatbotsessionschart) | **GET** /v1/chatbots/conversations/chart | Get chatbot sessions chart\n*ChatbotApi* | [**getChatbots**](docs/Api/ChatbotApi.md#getchatbots) | **GET** /v1/chatbots | Get chatbots for a user\n*ChatbotApi* | [**streamChatbotSession**](docs/Api/ChatbotApi.md#streamchatbotsession) | **POST** /v1/chatbots/sessions/{sessionId}/stream | Stream Chatbot Session\n*ChatbotApi* | [**updateChatbot**](docs/Api/ChatbotApi.md#updatechatbot) | **POST** /v1/chatbots/{id} | Update chatbot\n*ContentApi* | [**asyncMemoryLessAugment**](docs/Api/ContentApi.md#asyncmemorylessaugment) | **POST** /v1/content/augment/async | Async Augment based on the query and the given context\n*ContentApi* | [**complexAugment**](docs/Api/ContentApi.md#complexaugment) | **POST** /v1/content/complex-augment/async | Get Complex Async Augmentation result for multiple docs\n*ContentApi* | [**complexAugmentWithURLContext**](docs/Api/ContentApi.md#complexaugmentwithurlcontext) | **POST** /v1/content/augment/process/create | Augment based on given urls context\n*ContentApi* | [**getProcessResult**](docs/Api/ContentApi.md#getprocessresult) | **GET** /v1/content/augment/process/{id} | Get Async Augmentation result\n*ContentApi* | [**getRelatedUrls**](docs/Api/ContentApi.md#getrelatedurls) | **POST** /v1/content/related-urls | Related Urls to a specific url\n*ContentApi* | [**memoryLessAugment**](docs/Api/ContentApi.md#memorylessaugment) | **POST** /v1/content/augment | Augment based on the query and the given context\n*CreditsApi* | [**getCreditEvents**](docs/Api/CreditsApi.md#getcreditevents) | **GET** /v1/credits/events | Fetching Latest Events of user credit\n*CreditsApi* | [**getCreditEventsAggregation**](docs/Api/CreditsApi.md#getcrediteventsaggregation) | **GET** /v1/credits/events/aggregation | Fetching aggregated credit events\n*CreditsApi* | [**getLastCreditStatus**](docs/Api/CreditsApi.md#getlastcreditstatus) | **GET** /v1/credits | Fetching Last Status of user credit\n*DocsApi* | [**addDocument**](docs/Api/DocsApi.md#adddocument) | **PUT** /v1/content/docs | Add Custom Document\n*DocsApi* | [**deleteDocument**](docs/Api/DocsApi.md#deletedocument) | **DELETE** /v1/content/docs/{id} | Delete Document By Id\n*DocsApi* | [**getDocument**](docs/Api/DocsApi.md#getdocument) | **GET** /v1/content/docs/{id} | Get Document By Id\n*DocsApi* | [**searchDocuments**](docs/Api/DocsApi.md#searchdocuments) | **POST** /v1/content/docs | Get All Documents\n*DomainsApi* | [**getUserDomains**](docs/Api/DomainsApi.md#getuserdomains) | **GET** /v1/domains | Get Domains of a user\n*PublicAssetsApi* | [**loadCarouselThumbnail**](docs/Api/PublicAssetsApi.md#loadcarouselthumbnail) | **GET** /v1/public/screenshot/thumbnail/carousel/{bucketId} | Fetching thumbnail of carousel screenshot of url\n*PublicAssetsApi* | [**loadFullPageThumbnail**](docs/Api/PublicAssetsApi.md#loadfullpagethumbnail) | **GET** /v1/public/screenshot/thumbnail/fullpage/{bucketId} | Fetching thumbnail of fullpage screenshot of url\n*PublicAssetsApi* | [**loadImageCarousel**](docs/Api/PublicAssetsApi.md#loadimagecarousel) | **GET** /v1/public/screenshot/carousel/{bucketId} | Fetching carousel screenshot of url\n*PublicAssetsApi* | [**loadOriginalImage**](docs/Api/PublicAssetsApi.md#loadoriginalimage) | **GET** /v1/public/screenshot/fullpage/{bucketId} | Fetching fullpage screenshot of url\n*PublicAssetsApi* | [**loadTechnologyLogo**](docs/Api/PublicAssetsApi.md#loadtechnologylogo) | **GET** /v1/public/technologies/logos/{iconName} | Fetching icon logo of technology\n*ScheduleApi* | [**createSchedule**](docs/Api/ScheduleApi.md#createschedule) | **PUT** /v1/schedule | create a new schedule\n*ScheduleApi* | [**deleteSchedule**](docs/Api/ScheduleApi.md#deleteschedule) | **DELETE** /v1/schedule/{id} | delete a schedule\n*ScheduleApi* | [**getSchedule**](docs/Api/ScheduleApi.md#getschedule) | **GET** /v1/schedule/{id} | get a specific schedule details\n*ScheduleApi* | [**listSchedules**](docs/Api/ScheduleApi.md#listschedules) | **GET** /v1/schedule | get list of all schedules for the user\n*SerpApi* | [**bulkSearch**](docs/Api/SerpApi.md#bulksearch) | **POST** /v1/serp/bulk/search | Search the Serp to get top urls in bulk\n*SerpApi* | [**scheduleKeywordsAnalysis**](docs/Api/SerpApi.md#schedulekeywordsanalysis) | **POST** /v1/serp/bulk/search_volume | Get Google Ads Search Analytics\n*SerpApi* | [**search**](docs/Api/SerpApi.md#search) | **POST** /v1/serp/search | Search the Serp to get top urls\n*SnapshotApi* | [**getSnapshots**](docs/Api/SnapshotApi.md#getsnapshots) | **POST** /v1/snapshot | Get screenshot of url\n*SnapshotApi* | [**getSnapshotsHistory**](docs/Api/SnapshotApi.md#getsnapshotshistory) | **GET** /v1/snapshot/history | Get history of snapshot of url\n*SummaryApi* | [**getSummary**](docs/Api/SummaryApi.md#getsummary) | **POST** /v1/summary | Get summarization data for url\n*VideoApi* | [**getYTMicrodata**](docs/Api/VideoApi.md#getytmicrodata) | **POST** /v1/content/video/yt/microdata/{ytVidId} | get microdata for a youtube video\n*VideoApi* | [**getYTVidCaption**](docs/Api/VideoApi.md#getytvidcaption) | **POST** /v1/content/video/yt/transcribe/{ytVidId} | get transcript for a youtube video\n\n## Models\n\n- [DomainAcknowledged](docs/Model/DomainAcknowledged.md)\n- [DomainDataRetrievalAnalyticsSearchRequest](docs/Model/DomainDataRetrievalAnalyticsSearchRequest.md)\n- [DomainDataRetrievalAnalyticsSearchResponse](docs/Model/DomainDataRetrievalAnalyticsSearchResponse.md)\n- [DomainDataRetrievalAnalyticsSearchResponseRow](docs/Model/DomainDataRetrievalAnalyticsSearchResponseRow.md)\n- [DomainDataRetrievalAugmentPrompt](docs/Model/DomainDataRetrievalAugmentPrompt.md)\n- [DomainDataRetrievalAugmentRequest](docs/Model/DomainDataRetrievalAugmentRequest.md)\n- [DomainDataRetrievalAugmentRequestWithURLContext](docs/Model/DomainDataRetrievalAugmentRequestWithURLContext.md)\n- [DomainDataRetrievalAugmentResponse](docs/Model/DomainDataRetrievalAugmentResponse.md)\n- [DomainDataRetrievalComplexAugmentRequest](docs/Model/DomainDataRetrievalComplexAugmentRequest.md)\n- [DomainDataRetrievalComplexAugmentResponse](docs/Model/DomainDataRetrievalComplexAugmentResponse.md)\n- [DomainDataRetrievalContentQuery](docs/Model/DomainDataRetrievalContentQuery.md)\n- [DomainDataRetrievalDataRequest](docs/Model/DomainDataRetrievalDataRequest.md)\n- [DomainDataRetrievalKeywordAnalyticsBulkResponse](docs/Model/DomainDataRetrievalKeywordAnalyticsBulkResponse.md)\n- [DomainDataRetrievalKeywordAnalyticsResponse](docs/Model/DomainDataRetrievalKeywordAnalyticsResponse.md)\n- [DomainDataRetrievalMonthlySearches](docs/Model/DomainDataRetrievalMonthlySearches.md)\n- [DomainDataRetrievalRelatedUrlsRequest](docs/Model/DomainDataRetrievalRelatedUrlsRequest.md)\n- [DomainDataRetrievalRelatedUrlsResponse](docs/Model/DomainDataRetrievalRelatedUrlsResponse.md)\n- [DomainDataRetrievalScreenshotResponse](docs/Model/DomainDataRetrievalScreenshotResponse.md)\n- [DomainDataRetrievalSearchVolumeBulkRequest](docs/Model/DomainDataRetrievalSearchVolumeBulkRequest.md)\n- [DomainDataRetrievalSerpApiBulkSearchRequest](docs/Model/DomainDataRetrievalSerpApiBulkSearchRequest.md)\n- [DomainDataRetrievalSerpApiBulkSearchResponse](docs/Model/DomainDataRetrievalSerpApiBulkSearchResponse.md)\n- [DomainDataRetrievalSerpApiSearchRequest](docs/Model/DomainDataRetrievalSerpApiSearchRequest.md)\n- [DomainDataRetrievalSerpApiSearchResponse](docs/Model/DomainDataRetrievalSerpApiSearchResponse.md)\n- [DomainDataRetrievalSerpApiURL](docs/Model/DomainDataRetrievalSerpApiURL.md)\n- [DomainDataRetrievalSiteUrlsResponse](docs/Model/DomainDataRetrievalSiteUrlsResponse.md)\n- [DomainDataRetrievalSourceResponse](docs/Model/DomainDataRetrievalSourceResponse.md)\n- [DomainDataRetrievalStatefulResponse](docs/Model/DomainDataRetrievalStatefulResponse.md)\n- [DomainDataRetrievalSummaryResponse](docs/Model/DomainDataRetrievalSummaryResponse.md)\n- [DomainDataRetrievalUrlSnapshotMultiResponse](docs/Model/DomainDataRetrievalUrlSnapshotMultiResponse.md)\n- [DomainDataRetrievalUrlSnapshotResponse](docs/Model/DomainDataRetrievalUrlSnapshotResponse.md)\n- [DomainDataRetrievalVideoCaptionResponse](docs/Model/DomainDataRetrievalVideoCaptionResponse.md)\n- [DomainDataRetrievalVideoResponse](docs/Model/DomainDataRetrievalVideoResponse.md)\n- [DomainDocsDocIndexRequest](docs/Model/DomainDocsDocIndexRequest.md)\n- [DomainDocsDocResponse](docs/Model/DomainDocsDocResponse.md)\n- [DomainDocsSearchRequest](docs/Model/DomainDocsSearchRequest.md)\n- [DomainDocsUrlslabDocument](docs/Model/DomainDocsUrlslabDocument.md)\n- [DomainDomainsDomainBulkResponseDTO](docs/Model/DomainDomainsDomainBulkResponseDTO.md)\n- [DomainDomainsDomainRequestDTO](docs/Model/DomainDomainsDomainRequestDTO.md)\n- [DomainDomainsDomainResponseDTO](docs/Model/DomainDomainsDomainResponseDTO.md)\n- [DomainDomainsUrlResponseDTO](docs/Model/DomainDomainsUrlResponseDTO.md)\n- [DomainDomainsUrlScreenshotDTO](docs/Model/DomainDomainsUrlScreenshotDTO.md)\n- [DomainPaginationDateRange](docs/Model/DomainPaginationDateRange.md)\n- [DomainPaginationPagination](docs/Model/DomainPaginationPagination.md)\n- [DomainPaginationSorting](docs/Model/DomainPaginationSorting.md)\n- [DomainScheduleAPISchedule](docs/Model/DomainScheduleAPISchedule.md)\n- [DomainScheduleScheduleConf](docs/Model/DomainScheduleScheduleConf.md)\n- [DomainUrlslabIntegration](docs/Model/DomainUrlslabIntegration.md)\n- [DomainUserCreditAggregatedCreditEvents](docs/Model/DomainUserCreditAggregatedCreditEvents.md)\n- [DomainUserCreditAggregatedCreditResponse](docs/Model/DomainUserCreditAggregatedCreditResponse.md)\n- [DomainUserCreditCreditEvent](docs/Model/DomainUserCreditCreditEvent.md)\n- [DomainUserCreditCreditEventResponse](docs/Model/DomainUserCreditCreditEventResponse.md)\n- [DomainUserCreditCreditStatus](docs/Model/DomainUserCreditCreditStatus.md)\n- [SchemasExtrasChartsChartData](docs/Model/SchemasExtrasChartsChartData.md)\n- [SchemasExtrasChartsChartDataset](docs/Model/SchemasExtrasChartsChartDataset.md)\n- [SchemasExtrasCompleted](docs/Model/SchemasExtrasCompleted.md)\n- [SchemasRequestsChatbotChatCompletionRequest](docs/Model/SchemasRequestsChatbotChatCompletionRequest.md)\n- [SchemasRequestsChatbotChatbotCreate](docs/Model/SchemasRequestsChatbotChatbotCreate.md)\n- [SchemasResponsesChatbotChatbotConversationMessageResponse](docs/Model/SchemasResponsesChatbotChatbotConversationMessageResponse.md)\n- [SchemasResponsesChatbotChatbotResponse](docs/Model/SchemasResponsesChatbotChatbotResponse.md)\n- [SchemasResponsesChatbotChatbotSessionOverviewResponse](docs/Model/SchemasResponsesChatbotChatbotSessionOverviewResponse.md)\n- [SchemasResponsesChatbotChatbotSessionResponse](docs/Model/SchemasResponsesChatbotChatbotSessionResponse.md)\n- [SchemasResponsesChatbotChatbotSessionSource](docs/Model/SchemasResponsesChatbotChatbotSessionSource.md)\n\n## Authorization\n\n### UrlslabApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: X-URLSLAB-KEY\n- **Location**: HTTP header\n\n\n## Tests\n\nTo run the tests, use:\n\n```bash\ncomposer install\nvendor/bin/phpunit\n```\n\n## Author\n\n\n\n## About this package\n\nThis PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: `1.0.0`\n    - Package version: `0.5.2`\n- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Furlslab-php-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqualityunit%2Furlslab-php-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Furlslab-php-client/lists"}