How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Optimyzee Application API

The REST API behind the Optimyzee web application. Covers Google Ads campaign creation (search creation, AI search creation, keyword planner, RSA builder, sitelink builder), analysis (account audit, account health, search-terms optimization, Performance Max optimization and the P-Max center, reporting editor/querier), account linking (Google Ads, Meta, Merchant Center), lookups (campaigns, geo target constants, language constants), campaign lifecycle and activity, recommendations and signals, automations, Yelp Ads (autoresponders, leads, businesses, programs, reporting, sync), billing subscriptions, authentication (email, social gateway, password, TFA, trusted devices), plus an internal /operations administrative surface. The OpenAPI 3.0.0 document is served publicly and anonymously; there is no developer portal, human API reference, or published API program around it.

This API exposes 184 operations across 151 paths, organized into 40 resource areas, and defines 73 schemas. It is described by OpenAPI 3.0.0, at version 4.1.0.

Requests are made against a single base URL, https://api.optimyzee.com.

184 operations 151 paths 73 schemas 12 DELETE69 GET5 PATCH86 POST12 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.1.0
Base URL
https://api.optimyzee.com
Authentication
API Key
Resource Areas
40

Authentication & Security 1

Optimyzee Application API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (token).

  • token — Bearer token authorization

Paths & Operations 184

Across 151 paths, the API surfaces 184 operations — 12 DELETE, 69 GET, 5 PATCH, 86 POST, 12 PUT. They span 40 resource areas, including App/Analyze/GoogleAds/Audit, App/Analyze/GoogleAds/Health, App/Analyze/GoogleAds/Optimization, App/Analyze/GoogleAds/Reporting, App/Auth/Email, App/Auth/Gateway, App/Auth/Password, App/Auth/Profile, and 32 more. Each is listed below with its method, path, parameters, and response codes.

App/Analyze/GoogleAds/Audit 2

App/Analyze/GoogleAds/Audit

POST
/app/analyze/g/audit
appAnalyzeGoogleAdsAuditQueue body → 201403401
GET
/app/analyze/g/audit/{auditId}
appAnalyzeGoogleAdsAuditView 1 param → 200403401
App/Analyze/GoogleAds/Health 1

App/Analyze/GoogleAds/Health

POST
/app/analyze/g/health
appAnalyzeGoogleAdsHealthAnalyze body → 200403401
App/Analyze/GoogleAds/Optimization 15

App/Analyze/GoogleAds/Optimization

POST
/app/analyze/g/optimization/search-terms
appAnalyzeGoogleAdsOptimizationAnalyze body → 201
POST
/app/analyze/g/optimization/search-terms/results/mark
appAnalyzeGoogleAdsOptimizationMarkResult body → 200
POST
/app/analyze/g/optimization/p-max
appAnalyzeGoogleAdsOptimizationPMaxAnalyze body → 201
POST
/app/analyze/g/optimization/pmax-center/{optimizationId}/asset-draft
appAnalyzeGoogleAdsOptimizationPMaxCenterAssetDraft 1 param body → 200
POST
/app/analyze/g/optimization/pmax-center/deep-audit
appAnalyzeGoogleAdsOptimizationPMaxCenterDeepAudit body → 201
GET
/app/analyze/g/optimization/pmax-center/{optimizationId}/promotion-draft
appAnalyzeGoogleAdsOptimizationPMaxCenterPromotionDraftLatest 1 param → 200
POST
/app/analyze/g/optimization/pmax-center/{optimizationId}/promotion-draft
appAnalyzeGoogleAdsOptimizationPMaxCenterPromotionDraft 1 param body → 200
POST
/app/analyze/g/optimization/pmax-center/{optimizationId}/search-theme-suggestions
appAnalyzeGoogleAdsOptimizationPMaxCenterSearchThemeSuggestions 1 param body → 200
POST
/app/analyze/g/optimization/pmax-center/{optimizationId}/start
appAnalyzeGoogleAdsOptimizationPMaxCenterStart 1 param → 200403
GET
/app/analyze/g/optimization/pmax-center/{optimizationId}
appAnalyzeGoogleAdsOptimizationPMaxCenterView 1 param → 200
POST
/app/analyze/g/optimization/p-max/results/mark
appAnalyzeGoogleAdsOptimizationPMaxMarkResult body → 200
GET
/app/analyze/g/optimization/p-max/{id}
appAnalyzeGoogleAdsOptimizationPMaxView 1 param → 200
GET
/app/analyze/g/optimization/search-terms/{id}
appAnalyzeGoogleAdsOptimizationView 1 param → 200
GET
/app/analyze/g/optimization/optimized-history
appAnalyzeGoogleAdsOptimizationHistory 2 params → 200
GET
/app/analyze/g/optimization/recommendations
appAnalyzeGoogleAdsOptimizationRecommendations 3 params → 200
App/Analyze/GoogleAds/Reporting 2

App/Analyze/GoogleAds/Reporting

POST
/app/analyze/g/reporting/editor
appAnalyzeGoogleAdsReportingEditor body → 200422400403401
POST
/app/analyze/g/reporting/querier
appAnalyzeGoogleAdsReportingQuerier body → 200422400403401
App/Auth/Email 3

App/Auth/Email

POST
/app/auth/email/resend
appAuthEmailResend → 204403401
POST
/app/auth/email
appAuthEmailUpdate body → 204422403
POST
/app/auth/email/verify
appAuthEmailVerify body → 204422403
App/Auth/Gateway 8

App/Auth/Gateway

POST
/app/auth/gateway/email
appAuthGatewayEmail body → 200422400
POST
/app/auth/gateway/emailSignup
appAuthGatewayEmailSignup body → 200422400
POST
/app/auth/gateway/facebook
appAuthGatewayFacebook body → 200422400
POST
/app/auth/gateway/facebookSignup
appAuthGatewayFacebookSignup body → 200422400
POST
/app/auth/gateway/google
appAuthGatewayGoogle body → 200422400
POST
/app/auth/gateway/googleSignup
appAuthGatewayGoogleSignup body → 200422400
POST
/app/auth/gateway/refresh
appAuthGatewayRefresh body → 200422401
POST
/app/auth/gateway/revoke
appAuthGatewayRevoke body → 204422401
App/Auth/Password 2

App/Auth/Password

POST
/app/auth/password/reset
appAuthPasswordReset body → 204400422401
POST
/app/auth/password/sendResetLink
appAuthPasswordSendResetLink body → 204400422401
App/Auth/Profile 2

App/Auth/Profile

GET
/app/auth/profile
appAuthProfile → 200401
PUT
/app/auth/profile
appAuthProfileUpdate body → 204422401
App/Auth/Tfa 3

App/Auth/Tfa

POST
/app/auth/tfa/disable
appAuthTfaDisable body → 204403401
POST
/app/auth/tfa/enable
appAuthTfaEnable body → 204403401
POST
/app/auth/tfa/issue
appAuthTfaIssue → 200403401
App/Auth/TrustedDevice 5

App/Auth/TrustedDevice

GET
/app/auth/trustedDevice
appAuthTrustedDeviceQuery 2 params → 200401
POST
/app/auth/trustedDevice
appAuthTrustedDeviceCreate body → 204401
POST
/app/auth/trustedDevice/current
appAuthTrustedDeviceCurrent body → 200204401
GET
/app/auth/trustedDevice/{trustedDeviceId}
appAuthTrustedDeviceView 1 param → 200403401
DELETE
/app/auth/trustedDevice/{trustedDeviceId}
appAuthTrustedDeviceDelete 1 param → 204403401
App Automation 4

App Automation

DELETE
/app/automations/{automationId}
Delete an automation
8a4d6eaf33c6a8399451f759169cfa31 1 param → 204
POST
/app/automations/interpret
Interpret a natural-language intent into proposed automations
9cee8dd5e43b406f87a6d7785d79c22f body → 200
GET
/app/automations
List the current user's automations
ea27e985d6ee2548d8dcc475dddcc4db → 200
POST
/app/automations
Enable (persist) an automation
ca27bcedfbe5f11307e47810b1b2a0b9 → 200
App Automations 1

App Automations

GET
/app/automations/runs
List automation execution history for the current user
aeeca8c46e345b931240e55f10d4fd26 3 params → 200
App/Billing/Subscription 6

App/Billing/Subscription

POST
/app/billing/subscription/cancel
appBillingSubscriptionCancel → 204401
POST
/app/billing/subscription/charge
appBillingSubscriptionCharge → 204401
GET
/app/billing/subscription
appBillingSubscriptionQuery → 200
POST
/app/billing/subscription
appBillingSubscriptionSubscribe body → 200422403401
POST
/app/billing/subscription/session
appBillingSubscriptionSession body → 200422403401
POST
/app/billing/subscription/skip
appBillingSubscriptionSkip body → 204422403401
App/Campaign 6

App/Campaign

POST
/app/campaign/{campaignId}/activate
appCampaignActivate 1 param → 204403401
GET
/app/campaign/{campaignId}
appCampaignView 1 param → 200403401
DELETE
/app/campaign/{campaignId}
appCampaignDelete 1 param → 204403401
POST
/app/campaign/{campaignId}/optimization
appCampaignOptimization 1 param body → 204403401
POST
/app/campaign/{campaignId}/pause
appCampaignPause 1 param → 204403401
GET
/app/campaign
appCampaignQuery 4 params → 200422401
App/FreeLimit 1

App/FreeLimit

GET
/app/campaign/free-limit-check
appFreeLimitCheck 1 param → 200422401
App/Campaign/Activity 3

App/Campaign/Activity

POST
/app/campaign/activity/apply/{taskId}
appCampaignActivityApply 1 param → 204401403
POST
/app/campaign/activity/dismiss/{taskId}
appCampaignActivityDismiss 1 param body → 204401403
GET
/app/campaign/activity/{campaignId}
appCampaignActivityQuery 3 params → 200422401
App/Campaign/GoogleAds 4

App/Campaign/GoogleAds

POST
/app/campaign/googleAds/{campaignId}/access
appCampaignGoogleAdsAccess 1 param → 204403401
POST
/app/campaign/googleAds
appCampaignGoogleAdsCreate body → 201403401
GET
/app/campaign/googleAds/{campaignId}/metrics
appCampaignGoogleAdsMetrics 3 params → 200422401
POST
/app/campaign/googleAds/{campaignId}/refresh
appCampaignGoogleAdsRefresh 1 param → 204403401
App/Create/GoogleAds/KeywordPlanner 5

App/Create/GoogleAds/KeywordPlanner

GET
/app/create/g/keywordPlanner/{plannerId}/export
appCreateGoogleAdsKeywordPlannerExport 1 param → 200403401
POST
/app/create/g/keywordPlanner
appCreateGoogleAdsKeywordPlannerQueue body → 201422403401
POST
/app/create/g/keywordPlanner/{plannerId}/reprocess
appCreateGoogleAdsKeywordPlannerReprocess 1 param body → 204422403401
GET
/app/create/g/keywordPlanner/{plannerId}
appCreateGoogleAdsKeywordPlannerView 1 param → 200403401
PUT
/app/create/g/keywordPlanner/{plannerId}
appCreateGoogleAdsKeywordPlannerUpdate 1 param body → 204403401
App/Create/GoogleAds/RsaBuilder 5

App/Create/GoogleAds/RsaBuilder

GET
/app/create/g/rsaBuilder/{builderId}/export
appCreateGoogleAdsRsaBuilderExport 1 param → 200403401
POST
/app/create/g/rsaBuilder
appCreateGoogleAdsRsaBuilderQueue body → 201422403401
POST
/app/create/g/rsaBuilder/{builderId}/reprocess
appCreateGoogleAdsRsaBuilderReprocess 1 param body → 204422403401
GET
/app/create/g/rsaBuilder/{builderId}
appCreateGoogleAdsRsaBuilderView 1 param → 200403401
PUT
/app/create/g/rsaBuilder/{builderId}
appCreateGoogleAdsRsaBuilderUpdate 1 param body → 204403401
App/Create/GoogleAds/SearchCreation 6

App/Create/GoogleAds/SearchCreation

POST
/app/create/g/searchCreation
appCreateGoogleAdsSearchCreationCreate body → 201403401
POST
/app/create/g/searchCreation/{draftId}/publish
appCreateGoogleAdsSearchCreationPublish 1 param → 204403401
POST
/app/create/g/searchCreation/{draftId}/rebuild
appCreateGoogleAdsSearchCreationRebuild 1 param body → 204403401
GET
/app/create/g/searchCreation/{draftId}/status
appCreateGoogleAdsSearchCreationStatus 1 param → 200403401
GET
/app/create/g/searchCreation/{draftId}
appCreateGoogleAdsSearchCreationView 1 param → 200403401
PATCH
/app/create/g/searchCreation/{draftId}
appCreateGoogleAdsSearchCreationUpdate 1 param body → 204403401
App/Create/GoogleAds/SearchCreationAi 6

App/Create/GoogleAds/SearchCreationAi

POST
/app/create/g/searchCreationAi/{draftId}/keywordPlanner
appCreateGoogleAdsSearchCreationAiBuildKeywordPlanner 1 param body → 201403401422
POST
/app/create/g/searchCreationAi/{draftId}/rsa-builder
appCreateGoogleAdsSearchCreationAiBuildRsaAds 1 param → 201
POST
/app/create/g/searchCreationAi/{draftId}/stag-builder
appCreateGoogleAdsSearchCreationAiBuildStagStructure 1 param body → 201403401422
POST
/app/create/g/searchCreationAi
appCreateGoogleAdsSearchCreationAiCreate body → 201403401422
GET
/app/create/g/searchCreationAi/{draftId}/status
appCreateGoogleAdsSearchCreationAiStatus 1 param → 200403401
GET
/app/create/g/searchCreationAi/{draftId}
appCreateGoogleAdsSearchCreationAiView 1 param → 200403401
App/Create/GoogleAds/SitelinkBuilder 5

App/Create/GoogleAds/SitelinkBuilder

GET
/app/create/g/sitelinkBuilder/{builderId}/export
appCreateGoogleAdsSitelinkBuilderExport 1 param → 200403401
POST
/app/create/g/sitelinkBuilder
appCreateGoogleAdsSitelinkBuilderQueue body → 201422403401
POST
/app/create/g/sitelinkBuilder/{builderId}/reprocess
appCreateGoogleAdsSitelinkBuilderReprocess 1 param body → 204422403401
GET
/app/create/g/sitelinkBuilder/{builderId}
appCreateGoogleAdsSitelinkBuilderView 1 param → 200403401
PUT
/app/create/g/sitelinkBuilder/{builderId}
appCreateGoogleAdsSitelinkBuilderUpdate 1 param body → 204403401
App/Linking/GoogleAds 7

App/Linking/GoogleAds

GET
/app/linking/g/{linkingId}
appLinkingGoogleAdsView 1 param → 200403401
DELETE
/app/linking/g/{linkingId}
appLinkingGoogleAdsDelete 1 param → 204403401
GET
/app/linking/g/hierarchy
appLinkingGoogleAdsHierarchy → 200401
GET
/app/linking/g
appLinkingGoogleAdsQuery 4 params → 200422401
POST
/app/linking/g
appLinkingGoogleAdsIssue body → 204422400401
GET
/app/linking/g/{linkingId}/ping
appLinkingGoogleAdsPing 1 param → 204400403401
GET
/app/linking/g/uri
appLinkingGoogleAdsUri 1 param → 200401
App/Linking/Meta 7

App/Linking/Meta

GET
/app/linking/meta/{linkingId}/accounts
appLinkingMetaAccounts 1 param → 200403401
GET
/app/linking/meta/{linkingId}
appLinkingMetaView 1 param → 200403401
DELETE
/app/linking/meta/{linkingId}
appLinkingMetaDelete 1 param → 204403401
GET
/app/linking/meta/{linkingId}/ping
appLinkingMetaPing 1 param → 204403401
GET
/app/linking/meta
appLinkingMetaQuery 2 params → 200401
POST
/app/linking/meta/{linkingId}/select
appLinkingMetaSelectAccount 1 param body → 200422403401
GET
/app/linking/meta/uri
appLinkingMetaUri → 200401
App/Lookup/GoogleAds/Campaign 1

App/Lookup/GoogleAds/Campaign

GET
/app/lookup/g/campaign
appLookupGoogleAdsCampaignQuery 4 params → 200422401403
App/Lookup/GoogleAds/GeoTargetConstant 1

App/Lookup/GoogleAds/GeoTargetConstant

GET
/app/lookup/g/geoTargetConstant
appLookupGoogleAdsGeoTargetConstantQuery 3 params → 200422401
App/Lookup/GoogleAds/LanguageConstant 1

App/Lookup/GoogleAds/LanguageConstant

GET
/app/lookup/g/languageConstant
appLookupGoogleAdsLanguageConstantQuery → 200401
App/Lookup/GoogleAds/MerchantCenter 1

App/Lookup/GoogleAds/MerchantCenter

GET
/app/lookup/g/merchant-center
appLookupGoogleAdsMerchantCenterQuery 1 param → 200422401403
App Recommendation 2

App Recommendation

GET
/app/recommendations
List the current user's stored recommendations
a0beb9202425004a1461d531cc8378af 3 params → 200
PATCH
/app/recommendations/{recommendationId}
Update a recommendation status
02b67b9bb321e6ea93f11dd324815378 1 param body → 200
App Signal 1

App Signal

GET
/app/signals
Live readings from every registered signal connector
cf53c6cd627e8de50d4805cf385fe540 2 params → 200
App/Support 5

App/Support

POST
/app/support/beta
appSupportBeta body → 204422401
POST
/app/support/bug
appSupportBug body → 204422401
POST
/app/support/contact
appSupportContact body → 204422401
POST
/app/support/sales
appSupportSales body → 204422401
POST
/app/support
appSupport body → 204422401
App Yelp 31

App Yelp

POST
/app/yelp/ads-jobs/manual
Enqueue a manual guarded Yelp ads job (pause/resume/edit budget)
87a8e2fc068a01b14ca946663945073f body → 200
GET
/app/yelp/ads-jobs
List guarded Yelp ads jobs for the current user
93361097964ed54685cf6995e1f8693f 4 params → 200
POST
/app/yelp/autoresponders/runs/build
Build a local Yelp autoresponder reply queue from synced leads
ccee741c8bbc30958794d6eb13ccf59f → 200
POST
/app/yelp/autoresponders/check-status
Refresh local Yelp autoresponder status from synced rows
aa2c0af5abf4c029443b22adcfb56d96 → 200
DELETE
/app/yelp/autoresponders/{businessId}/messages/{messageId}
Delete a local Yelp autoresponder response-flow message
37787a868dbb00c7ad4eaa83ee3223d3 → 204
PATCH
/app/yelp/autoresponders/{businessId}/messages/{messageId}
Update a local Yelp autoresponder response-flow message
5a02874e694cb5ec2ce2cb6faccea1f5 → 200
GET
/app/yelp/autoresponders/{businessId}/messages
List local Yelp autoresponder response-flow messages
9a4691d8ca51168cfd3c2b186b0d1528 → 200
POST
/app/yelp/autoresponders/{businessId}/messages
Create a local Yelp autoresponder response-flow message
e72aba2c38e7af3d587a2a41932c561c → 200
GET
/app/yelp/autoresponders
List local Yelp autoresponder configurations
e934e579f8bfe2a64b031d9ef810835f → 200
POST
/app/yelp/autoresponders
Create a local Yelp autoresponder configuration
ebf1b7b3e8851d51d81c766dca7cfb48 → 200
GET
/app/yelp/autoresponders/runs
List local Yelp autoresponder queue runs
3940ff7c46484278c47889d3cf6a67dd → 200
POST
/app/yelp/autoresponders/runs/{runId}/send
Attempt to send an approved Yelp AI reply through the guarded outbound gateway
552a77744799ac6cae012edcb03f1183 1 param → 200
PATCH
/app/yelp/autoresponders/runs/{runId}
Approve or reject a local Yelp autoresponder run
49aca5f15c0b1d22c9b48246d2792540 1 param → 200
PATCH
/app/yelp/autoresponders/{businessId}
Update a local Yelp autoresponder configuration
9cdfe4982af3c6a7e9d45c3f013663e3 1 param → 200
PUT
/app/yelp/businesses/{businessRef}/profile
Update the editable AI business profile
a84c16ea96c1b0cc81b900e360d5c4e0 1 param → 200
GET
/app/yelp/businesses
List Yelp businesses synced for the current user
d18ce74a465956e45c007b8981ee6629 2 params → 200
GET
/app/yelp/businesses/{businessRef}/signal-settings
List signal eligibility settings for a Yelp business
4d8b164d24c20e418c08fbbdd235f5d5 1 param → 200
PUT
/app/yelp/businesses/{businessRef}/signal-settings/{signal}
Update one signal eligibility setting for a Yelp business
eaa5519d341275e6aad70f99e4bc1095 2 params → 200
GET
/app/yelp/businesses/{businessRef}
View a synced Yelp business
2b56d5bce97b82d148ba1be79d3b2410 1 param → 200
GET
/app/yelp/connection
View the current user's Yelp Partner connection
31452efe96c7bfeecf72d13ab99ebacb → 200
PUT
/app/yelp/connection
Create or update the current user's Yelp Partner connection
fea28f05944c841001d6611b02043301 → 200
DELETE
/app/yelp/connection
Delete the current user's Yelp Partner connection
722d186d7cd38b8f28cdbf2a7d07e34a → 204
POST
/app/yelp/connection/test
Validate the stored Yelp partner credentials against the Partner API
14a434b2ed966dc7289ee6b0864f3337 → 200
GET
/app/yelp/leads
List synced Yelp leads for the current user
bfebb54edfd97bd47c0aef794c9307d3 3 params → 200
POST
/app/yelp/leads/{leadId}/reply-draft
Generate a guarded AI reply draft for a synced Yelp lead
7172e519476825ed8f04e76993d08d14 1 param → 200
GET
/app/yelp/programs
List Yelp advertising programs synced for the current user
1a7c641667c9959a035781d6bf708ba7 2 params → 200
GET
/app/yelp/reporting
View aggregated synced Yelp reporting metrics
c69aa2a2d91077e38abba5dde0fd5e89 3 params → 200
GET
/app/yelp/sync-runs
List Yelp sync/import runs for the current user
fe2e1cadf35748e63a49477cbef7f6fd 4 params → 200
POST
/app/yelp/reporting/poll
Poll outstanding Yelp report requests and import ready ones
4dafd96fc7ba7be5e11747fae649862b → 200
POST
/app/yelp/reporting/request
Request a Yelp daily metrics report (async)
645e20a5c5ceefb632bcff1faf1d72b5 → 200
POST
/app/yelp/sync
Pull live businesses + programs from the Yelp Partner API
3ebada6ee2d7944c984d3868d728448a → 200
Operations/Admin 6

Operations/Admin

GET
/operations/admin
operationsAdminQuery 4 params → 200422403401
POST
/operations/admin
operationsAdminCreate body → 201422403401
GET
/operations/admin/{adminId}
operationsAdminView 1 param → 200403401
PUT
/operations/admin/{adminId}
operationsAdminUpdate 1 param body → 204422403401
DELETE
/operations/admin/{adminId}
operationsAdminDelete 1 param → 204403401
POST
/operations/admin/{adminId}/reset
operationsAdminReset 1 param → 204403401
Operations/Auth/Gateway 3

Operations/Auth/Gateway

POST
/operations/auth/gateway
operationsAuthGateway body → 200422400
POST
/operations/auth/gateway/refresh
operationsAuthGatewayRefresh → 200422401
POST
/operations/auth/gateway/revoke
operationsAuthGatewayRevoke → 204422401
Operations/Auth/Profile 1

Operations/Auth/Profile

GET
/operations/auth/profile
operationsAuthProfile → 200401
Operations/Billing/Subscription 5

Operations/Billing/Subscription

GET
/operations/billing/subscription
operationsBillingSubscriptionQuery 3 params → 200422403401
POST
/operations/billing/subscription
operationsBillingSubscriptionCreate body → 201422403401
GET
/operations/billing/subscription/{subscriptionId}
operationsBillingSubscriptionView 1 param → 200403401
PUT
/operations/billing/subscription/{subscriptionId}
operationsBillingSubscriptionUpdate 1 param body → 204422403401
DELETE
/operations/billing/subscription/{subscriptionId}
operationsBillingSubscriptionDelete 1 param → 204403401
Operations/Campaign 3

Operations/Campaign

GET
/operations/campaign
operationsCampaignQuery 7 params → 200422401
GET
/operations/campaign/{campaignId}
operationsCampaignView 1 param → 200403401
PUT
/operations/campaign/{campaignId}
operationsCampaignUpdate 1 param body → 204422403401
Operations/Campaign/Log 5

Operations/Campaign/Log

GET
/operations/campaign/log
operationsCampaignLogQuery 4 params → 200422403401
POST
/operations/campaign/log
operationsCampaignLogCreate body → 201422403401
GET
/operations/campaign/log/{logId}
operationsCampaignLogView 1 param → 200403401
PUT
/operations/campaign/log/{logId}
operationsCampaignLogUpdate 1 param body → 204422403401
DELETE
/operations/campaign/log/{logId}
operationsCampaignLogDelete 1 param → 204403401
Operations/Campaign/Task 5

Operations/Campaign/Task

GET
/operations/campaign/task
operationsCampaignTaskQuery 6 params → 200422403401
POST
/operations/campaign/task
operationsCampaignTaskCreate body → 201422403401
GET
/operations/campaign/task/{taskId}
operationsCampaignTaskView 1 param → 200403401
PUT
/operations/campaign/task/{taskId}
operationsCampaignTaskUpdate 1 param body → 204422403401
DELETE
/operations/campaign/task/{taskId}
operationsCampaignTaskDelete 1 param → 204403401
Operations/User 4

Operations/User

GET
/operations/user/{userId}
operationsUserView 1 param → 200403401
DELETE
/operations/user/{userId}
operationsUserDelete 1 param → 204403401
POST
/operations/user/{userId}/impersonate
operationsUserImpersonate 1 param → 200403401
GET
/operations/user
operationsUserQuery 3 params → 200422403401

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are AppYelpBusinessSchema (29 properties), AppRecommendationSchema (22 properties), AppYelpAutoresponderSchema (22 properties), AppYelpAutoresponderRunSchema (22 properties). Each schema is shown below with its type and property counts.

ErrorBagSchema
object
1 property 1 required
ErrorListSchema
object
1 property 1 required
ErrorSchema
object
2 properties 1 required
IdSchema
object
1 property 1 required
AppAnalyzeGoogleAdsAuditSchema
object
10 properties 9 required
AppAnalyzeGoogleAdsAuditResultSchema
object
9 properties 8 required
AppAnalyzeGoogleAdsHealthAccountSchema
object
3 properties 3 required
AppAnalyzeGoogleAdsHealthCampaignSchema
object
11 properties 11 required
AppAnalyzeGoogleAdsHealthDeltasSchema
object
Signed fractional change vs the previous period (0.25 = +25%). Any field may be null when the previous period had no comparable base.
8 properties 8 required
AppAnalyzeGoogleAdsHealthFlagSchema
object
3 properties 3 required
AppAnalyzeGoogleAdsHealthReportSchema
object
6 properties 6 required
AppAnalyzeGoogleAdsHealthMetricsSchema
object
10 properties 10 required
AppAnalyzeGoogleAdsReportingEditorResponseSchema
object
3 properties 3 required
AppAnalyzeGoogleAdsReportingRowSchema
object
AppAuthGatewayTokenSchema
object
2 properties 2 required
AppAuthProfileSchema
object
18 properties 18 required
AppAuthTfaCredentialsSchema
object
3 properties 3 required
AppAuthTrustedDeviceSchema
object
5 properties 5 required
AppAutomationConfigFieldSchema
object
3 properties 3 required
AppAutomationRunSchema
object
14 properties 14 required
AppAutomationSchema
object
15 properties 15 required
AppAutomationSpecSchema
object
15 properties 15 required
AppBillingSubscriptionCheckoutSchema
object
1 property 1 required
AppBillingSubscriptionSessionSchema
object
1 property 1 required
AppBillingSubscriptionSchema
object
9 properties 9 required
AppCampaignSchema
object
5 properties 5 required
AppCampaignActivityLogSchema
object
3 properties 3 required
AppCampaignActivitySubtaskSchema
object
7 properties 7 required
AppCampaignActivityTaskSchema
object
8 properties 10 required
AppCampaignGoogleAdsMetricsReportSchema
object
4 properties 4 required
AppCampaignGoogleAdsMetricsSchema
object
5 properties 5 required
AppCampaignGoogleAdsMetricsSummarySchema
object
4 properties 4 required
AppCreateGoogleAdsKeywordPlannerKeywordSchema
object
8 properties 8 required
AppCreateGoogleAdsKeywordPlannerSchema
object
8 properties 8 required
AppCreateGoogleAdsRsaBuilderSchema
object
6 properties 6 required
AppCreateGoogleAdsSearchCreationDraftKeywordSchema
object
8 properties 8 required
AppCreateGoogleAdsSearchCreationDraftSchema
object
16 properties 16 required
AppCreateGoogleAdsSearchCreationStatusSchema
object
1 property 1 required
AppCreateGoogleAdsSitelinkBuilderSchema
object
4 properties 4 required
AppCreateGoogleAdsSitelinkBuilderSitelinkSchema
object
5 properties 5 required
AppLinkingGoogleAdsHierarchySchema
object
9 properties 9 required
AppLinkingGoogleAdsSchema
object
8 properties 8 required
AppLinkingMerchantCenterSchema
object
5 properties 5 required
AppLinkingMetaAccountSchema
object
8 properties 8 required
AppLinkingMetaSchema
object
7 properties 7 required
AppLookupGoogleAdsCampaignSchema
object
3 properties 3 required
AppLookupGoogleAdsGeoTargetConstantSchema
object
6 properties 6 required
AppLookupGoogleAdsLanguageConstantSchema
object
3 properties 3 required
AppRecommendationSchema
object
22 properties 22 required
AppSignalReadingSchema
object
7 properties 7 required
AppYelpAdsJobSchema
object
20 properties 20 required
AppYelpAutoresponderMessageSchema
object
13 properties 13 required
AppYelpAutoresponderRunSchema
object
22 properties 22 required
AppYelpAutoresponderSchema
object
22 properties 22 required
AppYelpBusinessSchema
object
29 properties 29 required
AppYelpBusinessSignalSettingSchema
object
3 properties 3 required
AppYelpConnectionSchema
object
10 properties 10 required
AppYelpLeadSchema
object
18 properties 18 required
AppYelpProgramSchema
object
18 properties 18 required
AppYelpReportingDailyPointSchema
object
9 properties
AppYelpReportingKpiSchema
object
11 properties
AppYelpReportingLeadBreakdownSliceSchema
object
2 properties
AppYelpReportingSchema
object
3 properties 3 required
AppYelpSyncRunSchema
object
10 properties 10 required
OperationsAdminSchema
object
4 properties 4 required
OperationsAuthGatewayTokenSchema
object
2 properties 2 required
OperationsAuthProfileSchema
object
4 properties 4 required
OperationsBillingSubscriptionSchema
object
11 properties 11 required
OperationsCampaignSchema
object
17 properties 17 required
OperationsCampaignLogSchema
object
4 properties 4 required
OperationsCampaignTaskSchema
object
10 properties 10 required
OperationsUserTokenSchema
object
2 properties 2 required
OperationsUserSchema
object
11 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optimyzee-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Optimyzee Application API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.