Administrar gráficos

Lista, consulta, cambia y borra los gráficos de tu organización. Todo gratis.

Los gráficos hechos con cualquier key de tu organización, con POST /v1/charts. Ninguno de estos pedidos se cobra. Los gráficos guardados vencen a los 90 días con pago por uso y nunca con el plan mensual de créditos (expires_at); uno vencido o borrado responde 404 chart_not_found.

Listar gráficos

GEThttps://api.typesearch.ai/v1/charts

Tus gráficos, del más nuevo al más viejo, de a una página.

Consulta

ParámetroTipo
limitintegerCuántos, de 1 a 100. Por defecto: 20.
beforestringEl next_before de la página anterior.

Respuesta

  • object"list"

    Siempre list.

  • dataobject[]

    Los gráficos de tu organización, del más nuevo al más viejo.

    Ver los campos
    • idstring

      El id del gráfico.

    • typestring

      El tipo de gráfico.

    • titlestring

      Su título.

    • themestring

      Su tema.

    • localestring

      Su idioma.

    • created_atstring

      Cuándo se creó.

    • expires_atstring | null

      Cuándo vence, o null si nunca vence.

    • embed_urlstring

      La página para un iframe.

    • image_urlstring

      La PNG.

    • svg_urlstring

      El SVG.

  • has_moreboolean

    Si hay gráficos más viejos.

  • next_beforestring | null

    Pásalo como before para la página siguiente. null en la última.

Ver un gráfico

GEThttps://api.typesearch.ai/v1/charts/{id}

Un gráfico, con lo que se dibuja, su plan y sus fuentes: los mismos campos que la respuesta de POST /v1/charts, con usage.cost_usd en 0.

Ruta

ParámetroTipo
idstringEl id del gráfico, chart_….

Cambiar un gráfico

PATCHhttps://api.typesearch.ai/v1/charts/{id}

Cambia el tipo, el tema, el título, la bajada o el idioma, y vuelve a dibujar con los mismos datos: sin buscar de nuevo, gratis. Envía al menos un campo. type debería ser uno de los compatible_types del gráfico; si los datos no lo admiten, se dibuja con el tipo más cercano que sí y warnings lo dice (chart_type_adjusted). Sin un título tuyo, el título se vuelve a escribir para el nuevo tipo y el nuevo idioma.

embed_url, image_url y svg_url no cambian. Los embeds y las imágenes se guardan en caché 5 minutos, así que el cambio se ve ahí dentro de ese plazo.

Cuerpo

  • typeenum<string>

    El nuevo tipo de gráfico: uno de los compatible_types del gráfico. Si los datos no lo admiten, se dibuja el tipo más cercano, con un aviso chart_type_adjusted.

    Uno de: line · area · bar · bar_horizontal · stacked_bar · pie · donut · scatter · funnel · timeline · kpi · table

  • themeenum<string>

    light, dark, editorial o electric.

  • titlestring

    Un título nuevo. Sin un título tuyo, el título se vuelve a escribir para el nuevo tipo y el nuevo idioma.

  • subtitlestring

    Una bajada nueva.

  • localeenum<string>

    Lo vuelve a dibujar en otro idioma: en o es.

Respuesta

El gráfico actualizado, con los mismos campos que la respuesta de POST /v1/charts.

Borrar un gráfico

DELETEhttps://api.typesearch.ai/v1/charts/{id}

Borra el gráfico. Su embed, su imagen y su SVG dejan de funcionar; las copias que ya estaban en caché pueden tardar unos minutos en irse.

Ruta

ParámetroTipo
idstringEl id del gráfico, chart_….