dashboard

Jul 28, 2026

Changes in this version

+ var ErrApplicationNotFound = errors.New("application not found")

+ type APIKey struct

+ ACL []string

+ ApplicationID string

+ Description string

+ Indexes []string

+ MaxHitsPerQuery *int

+ MaxQueriesPerIPPerHour *int

+ QueryParameters *string

+ Referers []string

+ UUID string

+ Value string

type APIKeyAttributes

+ ACL []string

+ ApplicationID string

+ Description string

+ Indexes []string

+ MaxHitsPerQuery *int

+ MaxQueriesPerIPPerHour *int

+ QueryParameters *string

+ Referers []string

type Client

+ func (c *Client) CreateAPIKeyWithParams(accessToken, appID string, params CreateAPIKeyRequest) (APIKey, error)

type CreateAPIKeyRequest

+ Indexes []string

+ Referers []string

Jul 7, 2026

Changes in this version

type Application

+ APIKeyUUID string

type Client

+ func (c *Client) RotateAPIKey(accessToken, appID, keyUUID string) (CreatedAPIKey, error)

+ type CreatedAPIKey struct

+ UUID string

+ Value string

Jun 26, 2026

Changes in this version

+ const PlanTypeFree

type Application

+ PlanLabel string

type ApplicationAttributes

+ Plan ApplicationPlan

+ type ApplicationPlan struct

+ Label string

+ Name string

+ PayAsYouGo bool

+ Version int

+ type ChangePlanRequest struct

+ Plan string

type Client

+ func (c *Client) ChangeApplicationPlan(accessToken, appID, plan string) (*Application, error)

+ func (c *Client) GetSelfServePlans(accessToken string) ([]Plan, error)

+ func (c *Client) GetUser(accessToken string) (*DashboardUser, error)

+ func (c *Client) UpdateApplication(accessToken, appID, name string) (*Application, error)

+ type DashboardUser struct

+ HasPaymentMethod bool

+ type Plan struct

+ AcceptTerms string

+ Description string

+ ID string

+ Name string

+ Price string

+ Type string

+ func (p Plan) IsFree() bool

+ type PlanTemplateAttributes struct

+ Configuration PlanTemplateConfiguration

+ Description string

+ Freeform string

+ Name string

+ Type string

+ type PlanTemplateConfiguration struct

+ AcceptTerms string

+ Plan string

+ type PlanTemplateResource struct

+ Attributes PlanTemplateAttributes

+ ID string

+ Type string

+ type PlanTemplatesResponse struct

+ Data []PlanTemplateResource

+ type UpdateApplicationRequest struct

+ Name string

May 12, 2026

Changes in this version

type Client

+ func (c *Client) GetCrawlerUser(accessToken string) (*DashboardCrawlerUserData, error)

+ type DashboardCrawlerError struct

+ Detail *string

+ Status string

+ Title string

+ type DashboardCrawlerErrorResponse struct

+ Errors []DashboardCrawlerError

+ type DashboardCrawlerUserData struct

+ APIKey string

+ Email string

+ ID string

+ Name string

+ type DashboardCrawlerUserResponse struct

+ Data DashboardCrawlerUserData

Mar 27, 2026

Changes in this version

type ApplicationsResponse

+ Links PaginationLinks

+ Meta PaginationMeta

+ type PaginationLinks struct

+ First string

+ Last string

+ Next string

+ Prev string

+ type PaginationMeta struct

+ CurrentPage int

+ PerPage int

+ TotalCount int

+ TotalPages int

Mar 23, 2026

Changes in this version

+ var DefaultAPIURL = ""

+ var DefaultDashboardURL = ""

+ var DefaultOAuthScope = ""

+ var ErrSessionExpired = errors.New("session expired")

+ var WriteACL = []string

+ type APIKeyAttributes struct

+ Value string

+ type APIKeyResource struct

+ Attributes APIKeyAttributes

+ ID string

+ Type string

+ type Application struct

+ APIKey string

+ ID string

+ Name string

+ type ApplicationAttributes struct

+ APIKey string

+ ApplicationID string

+ Name string

+ type ApplicationResource struct

+ Attributes ApplicationAttributes

+ ID string

+ Type string

+ type ApplicationsResponse struct

+ Data []ApplicationResource

+ type Client struct

+ APIURL string

+ ClientID string

+ DashboardURL string

+ OAuthScope string

+ func NewClient(clientID string) *Client

+ func NewClientWithHTTPClient(clientID string, httpClient *http.Client) *Client

+ func (c *Client) AuthorizationCodeGrant(code, codeVerifier, redirectURI string) (*OAuthTokenResponse, error)

+ func (c *Client) AuthorizeURL(codeChallenge, redirectURI string) string

+ func (c *Client) CreateAPIKey(accessToken, appID string, acl []string, description string) (string, error)

+ func (c *Client) CreateApplication(accessToken, region, name string) (*Application, error)

+ func (c *Client) GetApplication(accessToken, appID string) (*Application, error)

+ func (c *Client) ListApplications(accessToken string) ([]Application, error)

+ func (c *Client) ListRegions(accessToken string) ([]Region, error)

+ func (c *Client) RefreshToken(refreshToken string) (*OAuthTokenResponse, error)

+ func (c *Client) RevokeToken(token string) error

+ func (c *Client) SignupAuthorizeURL(codeChallenge, redirectURI string) string

+ type CreateAPIKeyRequest struct

+ ACL []string

+ Description string

+ type CreateAPIKeyResponse struct

+ Data APIKeyResource

+ type CreateApplicationRequest struct

+ Name string

+ RegionCode string

+ type ErrClusterUnavailable struct

+ Message string

+ Region string

+ func (e *ErrClusterUnavailable) Error() string

+ type OAuthErrorResponse struct

+ Error string

+ ErrorDescription string

+ type OAuthTokenResponse struct

+ AccessToken string

+ CreatedAt int64

+ ExpiresIn int

+ RefreshToken string

+ Scope string

+ TokenType string

+ User *User

+ type Region struct

+ Code string

+ Name string

+ type RegionsResponse struct

+ RegionCodes []Region

+ type SingleApplicationResponse struct

+ Data ApplicationResource

+ type User struct

+ AvatarURL string

+ Email string

+ ID int

+ Name string