LLllmpulse
Projects

Project details

Changed on

Detailed info for one project: matching_names, additional_owned_domains, industry, business model, primary products, target audience, brand voice, locale, app store IDs, prompt_limit (the project's own prompt cap, null without one), stats (incl. prompts_by_brand_kind counts and prompts_available, how many prompts can still be added: the lower of the project's free slots and the account's remaining prompts, null when neither caps it), data_coverage (models, countries and languages with data), the status of each data connection (search_console, ai_traffic, agent_traffic) with the connect_url where the user connects it, and for a pitch project its pitch_expires_at and pitch_run (when it ran, the AI models it asked and how many answers arrived).

get/dimensions/projects/{id}

Request

  • Base URL
    https://api.llmpulse.ai/api/v1
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Response

Project details

idinteger
namestring

Internal project label (sidebar, settings, admin)

brand_namestring nullable

LLM-facing brand label (used in prompts and customer-facing charts). Null when not set, in which case prompts and charts use name.

trackedboolean required

Whether scheduled runs include this project. False when it is a pitch project, which runs once, when it is paused, or when the plan's project limit leaves it out (the oldest projects up to the limit run), so its prompts do not run

untracked_reasonstring nullable required

Why tracked is false: pitch_project, paused or project_limit. Null when tracked

pitchboolean

Whether this is a pitch project, a one-off snapshot that runs its prompts once, takes no project slot and is deleted at pitch_expires_at unless it is converted (PATCH /projects/{id} with pitch false)

pitch_expires_atstring date-time nullable

When a pitch project is deleted, with its data, unless it is converted first. Null for a tracked project

urlstring uri nullable
descriptionstring nullable
matching_namesstring[]
additional_owned_domainsstring[]

Other domains the brand owns (at most 10, each a website's own domain covering its subdomains), whose citations count as owned like the project website. Empty when none

industryunknown
business_modelstring nullable
business_model_otherstring nullable

Set only when business_model is OTHER

primary_productsstring[]
target_audiencestring nullable
brand_voicestring nullable
goalsstring nullable
country_codestring
language_codestring
pausedboolean
google_play_idstring nullable
app_store_idstring nullable
created_atstring date-time
prompt_limitinteger nullable

The most prompts this project can hold, set by the account owner or a co-owner (Account Settings > Prompt Limits). Null when the project has no limit of its own; the account's plan allowance applies either way

request_idstring

Changes