Personalizar filtros de fechas en paneles de KPI

Puede personalizar el filtro de fechas actualizando la estructura JSON del objeto de metadatos (MD) del filtro de fechas mediante la API. Puede:

  • Añadir, editar y quitar granularidades en el periodo relativo
  • Añadir, editar y quitar filtros en periodos predefinidos
  • Renombrar filtros
  • Establecer un filtro predeterminado para paneles de KPI nuevos

Para la estructura JSON predeterminada, vea la sección Estructura JSON predeterminada del filtro de fechas al final de este artículo.

Objeto de metadatos del filtro de fechas

Puede encontrar los objetos de metadatos del filtro de fechas en:

  • Para el espacio de trabajo completo: https://secure.gooddata.com/gdc/md/workspace_ID/objects/query?category=dateFilterConfig&limit=1

  • Para un panel ya creado: https://secure.gooddata.com/gdc/md/workspace_ID/obj/KPI_dashboard_ID

Cada filtro, o parte de un filtro, se identifica por:

  • localIdentifier - un identificador único de un filtro dentro de la estructura JSON
  • name - el nombre del filtro que se muestra en el panel de KPI Si deja el nombre vacío, el panel crea el nombre. Si añade un nombre, actualice también las versiones localizadas. Para más información, vea Localización de metadatos.

El tipo de los filtros se corresponde con los siguientes nombres JSON:

Nombre del panel de KPINombre JSON
De todo el tiempoallTime
Período estáticorelativePresets *
Periodo relativorelativeForm
Periodos predefinidosrelativePresets
* El periodo estático establecido se añade a la sección relativePresests de la estructura JSON.

Editar granularidades en el periodo relativo

El periodo relativo incluye granularidades que pueden ser días, semanas, meses, trimestres y años en el siguiente formato:

"GDC.time.week_us",  “GDC.time.month”,  “GDC.time.year”,  “GDC.time.quarter”,  “GDC.time.date”

Si quiere eliminar alguna granularidad, elimine el elemento de la sección relativeForm. El siguiente código muestra el periodo relativo con solo meses y años.

"relativeForm" : { "granularities" : [ "GDC.time.month", "GDC.time.year" ], "localIdentifier" : "relativeForm", "name" : "relativeForm", "visible" : true },

Añadir periodos predefinidos

En la sección relativePresets de la estructura JSON, puede editar los periodos predefinidos del filtro de fechas.

Cada periodo predefinido consiste en lo siguiente:

  • granularidad que puede ser días, semanas, meses, trimestres y años en el siguiente formato:

    "GDC.time.week_us",  "GDC.time.month",  "GDC.time.year",  "GDC.time.quarter",  "GDC.time.date"

  • desde y hasta que especifica la duración del periodo en función de la granularidad y en relación con el día de hoy En función de la granularidad, el número especifica la distancia desde hoy (que siempre es cero).  Aquí tiene algunos ejemplos:

    DesdeHastaGranularidadNotas
    -20GDC.time.dateÚltimos 3 días
    03GDC.time.week_usDentro de 4 semanas
    -21GDC.time.monthHace 2 meses hasta dentro de 1 mes
    -1-1GDC.time.quarterÚltimo trimestre
    00GDC.time.yearEste año
  • localIdentifier es un nombre único dentro del objeto de metadatos del filtro de fechas

  • name es el nombre del filtro que se muestra en el panel de KPI

  • visible especifica si el filtro está disponible en el panel

El siguiente código muestra un valor preestablecido nuevo que filtra hasta los últimos 10 días y es visible en el panel.

{ "from" : -9, "granularity" : "GDC.time.date", "localIdentifier" : "last_10_days", "name" : "Last 10 days", "to" : 0, "visible" : true },

Renombrar filtros

Para renombrar un filtro de fechas o parte de él, edite el parámetro name para dicho filtro. Si deja el nombre vacío, se creará uno automáticamente.

El siguiente código muestra el “Periodo relativo” renombrado como “Establecer un filtro relativo”.

"relativeForm" : { "granularities" : [ "GDC.time.month", "GDC.time.year", "GDC.time.quarter", "GDC.time.date" ], "localIdentifier" : "relativeForm", "name" : "Set a relative filter", "visible" : true },

Cambiar el filtro predeterminado para paneles nuevos

El parámetro selectedOption determina qué filtro de fechas se muestra como predeterminado para los paneles nuevos de KPI.

De forma predeterminada, todos los paneles de KPI nuevos se filtran a Este mes.

Para cambiar el filtro predeterminado, añada su localIdentifier al parámetro selectedOption.

"selectedOption" : "relative_last_7_days"

Estructura JSON predeterminada del filtro de fechas

La estructura JSON para el filtro de fechas consiste en la definición de filtros individuales.

Puede utilizar la siguiente estructura JSON predeterminada como referencia o para actualizar su filtro de fecha.

 { "dateFilterConfig" : { "content" : { "absoluteForm" : { "localIdentifier" : "absoluteForm", "name" : "absoluteForm", "visible" : true }, "allTime" : { "localIdentifier" : "allTime", "name" : "allTime", "visible" : true }, "relativeForm" : { "granularities" : [ "GDC.time.week_us", "GDC.time.month", "GDC.time.year", "GDC.time.quarter", "GDC.time.date" ], "localIdentifier" : "relativeForm", "name" : "relativeForm", "visible" : true }, "relativePresets" : [ { "from" : -6, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_7_days", "name" : "Last 7 days", "to" : 0, "visible" : true }, { "from" : -29, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_30_days", "name" : "Last 30 days", "to" : 0, "visible" : true }, { "from" : -89, "granularity" : "GDC.time.date", "localIdentifier" : "relative_last_90_days", "name" : "Last 90 days", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_this_week", "name" : "This week", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_last_week", "name" : "Last week", "to" : -1, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.week_us", "localIdentifier" : "relative_last_two_weeks", "name" : "Last two weeks", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.month", "localIdentifier" : "relative_this_month", "name" : "This month", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.month", "localIdentifier" : "relative_last_month", "name" : "Last month", "to" : -1, "visible" : true }, { "from" : -11, "granularity" : "GDC.time.month", "localIdentifier" : "relative_last_12_months", "name" : "Last 12 months", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_this_quarter", "name" : "This quarter", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_last_quarter", "name" : "Last quarter", "to" : -1, "visible" : true }, { "from" : -3, "granularity" : "GDC.time.quarter", "localIdentifier" : "relative_last_4_quarters", "name" : "Last 4 quarters", "to" : 0, "visible" : true }, { "from" : 0, "granularity" : "GDC.time.year", "localIdentifier" : "relative_this_year", "name" : "This year", "to" : 0, "visible" : true }, { "from" : -1, "granularity" : "GDC.time.year", "localIdentifier" : "relative_last_year", "name" : "Last year", "to" : -1, "visible" : true } ], "selectedOption" : "relative_this_month" } } }